Commit Graph

248 Commits

Author SHA1 Message Date
George ElKoura
87a7fd831c Added references section to the documentation
- Added new references section for folks wishing to learn more about
  subdivision.
- Fixed a reference in the intro.
- Fixed a minor typo in the nav bar.
2015-07-13 18:13:54 -07:00
jcowles
3c9facd85c Replaced Geri's game image with Inside Out 2015-06-23 13:22:47 -07:00
Takahito Tejima
fc28a17b1b Merge pull request #690 from davidgyu/docs
Added a link for face-varying to the nav sidebar
2015-06-23 10:26:28 -07:00
David G Yu
11f6af9b8e Added a link for face-varying to the nav sidebar 2015-06-23 10:23:43 -07:00
Takahito Tejima
faf11628a7 Merge pull request #688 from jcowles/dev-docs
Update documentation logos
2015-06-23 10:20:06 -07:00
Jeremy Cowles
44f9dc1276 Updated logo and header icons 2015-06-23 09:57:12 -07:00
Takahito Tejima
6cb5d188d1 update boundary interpolation diagram. 2015-06-23 09:27:10 -07:00
David G Yu
3227d6042e Merge pull request #687 from poljere/fix_documentation
Minor changes/fixes in the documentation
2015-06-23 07:48:06 -07:00
Pol Jeremias Vila
7a83173023 getting_started.rst : download opensubdiv link now points to master version instead of the dev version; intro.rst : minor changes in the text; cmake_build.rst : consistent capitalization in CMake; code_examples and maya_osdpolysmooth : Instead of calling it just osdpolysmooth, now we refer to it as Maya osdpolysmooth 2015-06-22 22:56:07 -07:00
George ElKoura
b7e7334e43 Merge pull request #686 from davidgyu/doctest
Added some minor grammar and spelling fixes
2015-06-22 22:01:24 -07:00
David G Yu
248ebcaabc Merge pull request #684 from c64kernal/dev_doxtwk
More small tweaks to the docs.
2015-06-22 20:32:53 -07:00
jmooney
c808f8df2d Added some minor grammar and spelling fixes
The changes are mostly limited to punctuation fixes, though some sentences
were restructured for clarity.

The files modified include:
	- documentation/porting.rst
	- documentation/sdc_overview.rst
2015-06-22 20:24:43 -07:00
George ElKoura
427eda6841 Merge pull request #685 from takahito-tejima/doc
updating diagrams. make backgrounds transparent.
2015-06-22 20:15:42 -07:00
Takahito Tejima
ef8f1ae890 updating diagrams. make backgrounds transparent. 2015-06-22 20:06:47 -07:00
David G Yu
a74838cc91 Merge pull request #683 from c64kernal/dev_doxsm
Remove the 'Next' link in getting_started.
2015-06-22 20:00:17 -07:00
George ElKoura
a717276a64 More small tweaks to the docs.
- Removed out-of-place one-liners that remained at the top of some of the
  pages.

- Fixed formatting of an "important" note in cmake_build.

- Add table of contents for consistency to the contributing page.
2015-06-22 19:53:52 -07:00
George ElKoura
5e8ec2b31b Remove the 'Next' link in getting_started.
It was the only document that had such a next link.  Also
that became no longer true when we put the contributing
doc between it and the building doc.
2015-06-22 19:35:55 -07:00
George ElKoura
a9b9930f83 Minor tweaks to the compatibility page. 2015-06-22 19:22:22 -07:00
George ElKoura
51704dc1db Merge pull request #679 from davidgyu/subdivDox
Updated subdivision surface intro page
2015-06-22 19:08:01 -07:00
David G Yu
8405dbacfe Some more updates to the far_overview 2015-06-22 18:30:42 -07:00
David G Yu
37ce73ccbe Updated subdivision surface intro page
Moved the description of uniform and adaptive refinement to
earlier in the page and also updated the table comparing the
two methods.

Previously, the table contained many restrictions related to
our use of Hbr which no longer need to be considered.
2015-06-22 18:07:45 -07:00
barfowl
7c3d646921 Merge pull request #678 from takahito-tejima/doc
minor update in overview pages
2015-06-22 17:45:33 -07:00
Takahito Tejima
b45c7b918f Merge pull request #677 from jcowles/dev-docs
Added "contributing" doc + minor doc cleanup
2015-06-22 17:41:45 -07:00
Takahito Tejima
65b8a56b96 update overviews: remove tiny api_layer images 2015-06-22 17:37:41 -07:00
Takahito Tejima
63374e2c71 minor update in api_overview: add some links to deeper sections. 2015-06-22 17:37:41 -07:00
Takahito Tejima
b789e84767 Merge pull request #676 from barfowl/api_overview
Minor updates to the API overview documentation pages
2015-06-22 17:36:44 -07:00
Jeremy Cowles
15af3862bd Merge pull request #673 from davidgyu/farDocs
Updated documentation/images/far_stencil5.png
2015-06-22 19:13:26 -04:00
jcowles
7f8fc77cfc Added "contributing" doc + minor doc cleanup
This is a good start, but more could be done to make it even more useful for
developers.

 * Updated nav_template to include contributing
 * Removed contributing from intro
 * Fixed RST compiler error in hedits
 * Renamed "OpenSubdiv" header in nav to "OpenSubdiv User Guide"
2015-06-22 16:12:55 -07:00
David G Yu
c9ba285e19 Merge pull request #674 from barfowl/doc_compat
Improvements to the Compatibility doc page
2015-06-22 15:49:16 -07:00
barfowl
3556203e12 Minor updates to the API overview documentation pages 2015-06-22 15:22:24 -07:00
barfowl
aea43617de Suggested improvements to the Compatibility doc page. 2015-06-22 14:48:18 -07:00
David G Yu
49e5a90391 Updated documentation/images/far_stencil5.png
The image now reflects the current class names.
2015-06-22 14:41:02 -07:00
Takahito Tejima
8dfbbe1f3b minor update in osd_overview. 2015-06-22 14:15:13 -07:00
jcowles
3a79059590 Minor overview doc changes and nav title update
Having two introduction sections in the navigation bar was awkward, here I've
left "introduction" as-is but changed "Introduction to 3.0" to "Release 3.0" and
"Release 3.0" to "Overview".
2015-06-22 13:32:34 -07:00
Takahito Tejima
e008776325 fix legacy gregory patch shader to support higher valence
Note that the actual limitation stays same, due to hardware capability
(GL_MAX_VARYING_VECTORS)
2015-06-22 11:08:11 -07:00
George ElKoura
2103d9e159 Merge pull request #668 from barfowl/doc_compat
More documentation updates to the compatibility page
2015-06-22 08:29:47 -07:00
Takahito Tejima
3523dc8be7 Merge pull request #667 from c64kernal/dev_doxosd
Minor typo fixing and editing for osd_overview.
2015-06-22 08:21:38 -07:00
barfowl
a21c568b51 Updates to Compatibility page of documentation:
- completed RenderMan differences (FVar with creasing, chaikin, accuracy)
    - revised diagram for "bowtie vertex" case with smooth corners
    - amended FVar section with diagrams illustrating "corners only" vs "plus1"
2015-06-22 06:44:46 -07:00
barfowl
a93d3a0c5c Merge pull request #666 from c64kernal/dev_doxsp
Fixing up minor typos throughout the docs.
2015-06-21 23:04:00 -07:00
barfowl
fc45b4c79b Merge pull request #663 from c64kernal/dev_doxfar
Simplifying Porting Guide
2015-06-21 23:03:35 -07:00
George ElKoura
b59e2c380c Minor typo fixing and editing for osd_shader_interface. 2015-06-21 18:48:04 -07:00
George ElKoura
85141c1da4 Minor typo fixing and editing for osd_overview. 2015-06-21 18:37:20 -07:00
George ElKoura
bc9916adb5 Further editing down of Porting Guide.
Combined two sections that repeated information in the Porting Guide.
2015-06-21 18:13:23 -07:00
George ElKoura
bca07d2ff9 Minor fix to the porting guide.
Removing a line from the porting guide that no longer makes sense.
2015-06-21 17:56:52 -07:00
George ElKoura
4481344019 Fixing up minor typos throughout the docs. 2015-06-20 22:31:03 -07:00
barfowl
9200268749 More updates to the Subdivision Compatibility page
- added description and figure for cases leading to Hbr "split" vertices
2015-06-20 19:52:00 -07:00
barfowl
22a2271bfc Merge pull request #664 from c64kernal/dev_doxintro
Update introduction text.
2015-06-20 17:19:36 -07:00
barfowl
db40864c59 Merge pull request #662 from c64kernal/dev_doxcmp
Minor clean ups to the Compatibility page.
2015-06-20 17:19:19 -07:00
George ElKoura
1732470da6 Update introduction text. 2015-06-20 16:11:15 -07:00
George ElKoura
6641e898b7 A few more typos in compatibility.rst 2015-06-20 16:04:02 -07:00
George ElKoura
2d9d872855 Simplifying Porting Guide
Moved big sections out of the porting guide and merged them into
the overview for Far documentation.
2015-06-20 15:55:48 -07:00
George ElKoura
277186234b Minor clean ups to the Compatibility page. 2015-06-20 14:04:37 -07:00
George ElKoura
a85a807e71 Moved the Hbr and Hierarchical Edits documents
The Hbr and Hierarchical Edits documents are now clearly marked in a
deprecated section.
2015-06-20 13:20:46 -07:00
George ElKoura
940fb00994 Minor changes to intro_30.rst
- Renamed nav bar title to 'Release 3.0' to match document.
- Minor tweaks and typo fixes.
2015-06-19 19:31:21 -07:00
David G Yu
1294e1b0c1 Updated far_overview to include PrimvarRefiner
This updates much of the initial overview documentation
to make a clearer distinction between topology refinement
and primvar refinement and describes the different classes
and methods that are used.
2015-06-19 16:36:10 -07:00
George ElKoura
5235f9f189 Merge pull request #654 from davidgyu/releaseDocs
Changed most .impnotip doc notes to .notebox
2015-06-19 14:48:13 -07:00
Takahito Tejima
159b3b5885 revise API overview page
- merge using_osd page (table of contents) into api_overview
- add short descriptions into the layers list
- add two representative use cases.
2015-06-19 14:22:29 -07:00
David G Yu
cefd1efcc8 Merge pull request #655 from barfowl/porting_doc
A few more updates to the Porting Guide
2015-06-19 14:05:07 -07:00
barfowl
916c9be444 A few more updates to the Porting Guide:
- added a brief subsection dealing with changes for Face Varying
    - added a subsection on ordering of refined vertices and faces
2015-06-19 12:11:42 -07:00
David G Yu
05a28bfa93 Changed most .impnotip doc notes to .notebox 2015-06-19 11:00:52 -07:00
David G Yu
7bdfbcd342 Merge pull request #650 from c64kernal/dev_doxhe
Remove documentation for hierarchical edits.
2015-06-19 09:57:22 -07:00
barfowl
3a0bcb870e Updates to 3.0 Intro and Release Notes docs
- reordered items in Release Notes and Intro to 3.0
    - other minor updates to Compatibility page
2015-06-18 21:04:00 -07:00
George ElKoura
9e8bbd99bd Remove documentation for hierarchical edits.
Hierarchical Edits have been deprecated in OSD 3.0, so
remove the documentation for them from the main pages.
I put the extracted docs in a file rather than deleting
them in case we want to refer to them later easily.
2015-06-18 19:34:49 -07:00
David G Yu
ccf2690416 Merge pull request #646 from barfowl/doc_updates
A few incremental updates to a number of documentation pages
2015-06-18 18:08:51 -07:00
barfowl
4543c9f8bc A few incremental updates to a number of documentation pages 2015-06-18 17:30:15 -07:00
Takahito Tejima
87d35ea886 fix document build 2015-06-18 16:40:27 -07:00
Takahito Tejima
0172b9ae5f Merge pull request #644 from c64kernal/dev_doxmt
Moved Modeling Tips under Subdivision Surfaces in docs nav bar
2015-06-18 15:49:25 -07:00
Takahito Tejima
4f8a4b0e41 Merge branch 'dev_doxbld' of https://github.com/c64kernal/OpenSubdiv into c64kernal-dev_doxbld
Conflicts:
	documentation/nav_template.txt
2015-06-18 15:27:04 -07:00
George ElKoura
e219317763 Moved Modeling Tips under Subdivision Surfaces 2015-06-18 15:21:43 -07:00
Takahito Tejima
8d9f4751f1 update doc: simplify the release note as previous releases.
The detail of 3.0 changes are explained in the "Introduction to 3.0" page.
2015-06-18 15:17:28 -07:00
Takahito Tejima
6bc13df93b update doc: fix a layout issue in osd_overview 2015-06-18 15:11:41 -07:00
Takahito Tejima
6b6f61979f update doc: flip the order of API layers. sdc > vtr > far > osd.
remove the paragraph of representation vs implementation.
2015-06-18 15:11:04 -07:00
Takahito Tejima
1e52887e3f Merge pull request #641 from c64kernal/dev_doxtex
Removed link to incomplete 'Textures' doc.
2015-06-18 09:46:23 -07:00
George ElKoura
6172baa1ff Cleaned up 'Compile & Link' document.
Folded 'Compiling & Linking' document into 'Building OpenSubdiv'.
2015-06-17 22:04:16 -07:00
George ElKoura
dfc303e59d Removed link to incomplete 'Textures' doc.
Removed the link to the 'Textures' document because it is incomplete.
Still keep the texture document (in the tree and in the CMakeLists.txt to one day revive.
2015-06-17 21:38:25 -07:00
George ElKoura
a51456963c Reorganized Release Notes
Modified Release Notes to be a brief overview of the 3.0 release
features, while moving the descriptive text to a new section that
outlines the major changes in 3.0 grouped along with the Porting
Guide and Subdivision Compatibility document.
2015-06-17 20:19:14 -07:00
Takahito Tejima
c9fbc2c49d doc update: remove the obsolete usecase flow chart (for now) 2015-06-17 17:48:00 -07:00
Takahito Tejima
0ab4076286 doc update: replace old references to ComputeContext and ComputeController. 2015-06-17 17:40:25 -07:00
Takahito Tejima
4f2c33bf08 update osd layer documents
- the first pass of revised Osd overview
- add a new doc for osd shader interface.
- update the api layers diagram.
2015-06-17 17:26:09 -07:00
David G Yu
4513cdcbac Updated far_overview PatchTable documentation
Added information about recent PatchParam changes as well
as some discussion of Single-Crease patches, Local Points,
and Legacy Gregory patches.
2015-06-17 17:07:28 -07:00
David G Yu
72dcbd37a0 Fixed references to Osd::DrawContext/Controller
These have been replaced with the new Evaluator and
Patch Drawing interfaces.
2015-06-17 15:58:18 -07:00
David G Yu
bc4ca8f212 Fixed typo in subdivision_surfaces.rst 2015-06-17 11:22:47 -07:00
David G Yu
27eb0d3cac Updated documentation of VTX_BOUNDARY_NONE 2015-06-17 11:14:06 -07:00
David G Yu
3982bece8d Updated face-varing interpolation image
The new image illustrates all face-varying interpolation options
using the catmark_fvar_bound1 regression shape.
2015-06-17 10:00:33 -07:00
George ElKoura
40c5dbdd82 Split out Compatiblity Guide into a separate page.
The compatibility portions of the "Porting Guide" are
now split into a different page.  We'd like to keep
the "Porting Guide" simple and easy to understand.
The Compatiblity portion may live on longer than what
is just needed for Porting from 2.x to 3.0.
2015-06-15 20:16:47 -07:00
David G Yu
38d75aac60 Merge pull request #632 from c64kernal/dev_dox
A few tweaks to the roadmap.
2015-06-15 10:31:56 -07:00
barfowl
6b8544d2f0 More updates to Release Notes and Porting Guide 2015-06-12 20:58:49 -07:00
George ElKoura
ee80057cdf A few tweaks to the roadmap. 2015-06-12 20:27:32 -07:00
Takahito Tejima
bb1fa6a9ee RC2.
- changed the namespace version
- updated release notes
2015-06-11 18:30:55 -07:00
Jeremy Cowles
1f2d12f496 Merge pull request #623 from barfowl/doc_updates
More revisions to documentation pages
2015-06-10 17:43:12 -07:00
barfowl
97adfc282a More revisions to documentation pages 2015-06-10 11:43:18 -07:00
barfowl
07e00c1f93 Added more content to the docs for porting and compatibility 2015-06-09 17:03:27 -07:00
Takahito Tejima
e7e1accade Merge pull request #618 from jcowles/dev-docs
Added porting guide to public documentation
2015-06-09 16:03:22 -07:00
jcowles
62681bf791 Added porting guide to public documentation
This document is a work in progress with some sections left incomplete for other
developers to fill in.
2015-06-09 13:21:03 -07:00
Jeremy Cowles
093b31011a Merge pull request #613 from c64kernal/dev_doc
A few small updates to the docs.
2015-06-09 10:32:21 -07:00
barfowl
e1f0748b8e Minor revisions to documentation files 2015-06-08 20:08:46 -07:00
George ElKoura
6f4c395dbe A few small updates to the docs.
- Make our intentions about Face-varying support clear.
- Remove outdated "Patch Transitions" section.
- Remove outdated Beta note regarding control vertices ordering.
2015-06-08 18:56:02 -07:00
Takahito Tejima
9716631864 release note updates about single crease patch and endcaps. 2015-06-05 09:59:19 -07:00
Jeremy Cowles
4e568d6657 Additional release notes update 2015-06-03 23:38:42 -07:00
Jeremy Cowles
0ea8acf89b Updating RC1 release notes 2015-06-03 23:01:01 -07:00