Commit Graph

283 Commits

Author SHA1 Message Date
barry
574f77f59f Updated documentation for the example applications:
- added common set of command line arguments to the main examples page
    - updated pages for each example to reflect revised usage
    - updated the See Also list
2019-04-01 10:15:33 -07:00
barry
7aff9287d8 Reorganized Far tutorials into groups:
- moved and renumbered the 11 Far tutorials into 5 groups
    - updated documentation/tutorials.rst:
        - replaced the two-column tables with simple sections
        - created sub-sections describing the Far tutorial groups
    - updated additional Far tutorial references for new numbering
2019-03-21 18:43:02 -07:00
Pol
c6b100218e
Merge pull request #1072 from c64kernal/dev_rmoldimages
Removed unused old logo images from documentation
2019-03-04 15:10:51 -08:00
Pol
77b67d35a5
Merge pull request #1071 from c64kernal/dev_newlogo
Use new OpenSubdiv logos
2019-03-04 15:10:15 -08:00
George ElKoura
a3ad4a51dc Removed unused old logo images from documentation 2019-03-02 23:43:57 -08:00
George ElKoura
67fbf96014 Use new OpenSubdiv logos 2019-03-02 23:35:54 -08:00
George ElKoura
409669b7f9 Minor modification to the contribution docs.
- Removed explicit username and replaced it with generic example username.
2019-02-27 16:52:44 -08:00
barry
6cae3a8e6d Additions and minor improvements to far/tutorials:
- added far/tutorial_10 illustrating variable width vertex class
    - revised far/tutorial_9 for command line and documentation conventions
    - updated doc/tutorials.rst with missing and new tutorial descriptions
2019-02-13 11:37:41 -08:00
barry
809ed21e7b Major revision to introductory documentation on Subdivision Surfaces:
- rewrite of the leading sections of subdivision_surfaces.rst
        - new images added in a previous commit
    - updated nav_template.rst for the new sections
2018-08-03 18:51:26 -07:00
barry
259f8636a6 Added files to documentation/images needed by upcoming revisions 2018-08-03 18:49:44 -07:00
David G Yu
3b5c3d99d2 Release 3.3.3 2018-07-17 19:17:49 -07:00
David G Yu
70e3c5f300 Release 3.3.2 2018-06-27 14:29:08 -07:00
David G Yu
171629fbd8 Release 3.3.1 2018-02-07 15:09:46 -08:00
David G Yu
195111a8e1 Release 3.3.0 2017-07-25 13:58:09 -07:00
David G Yu
938d7ca1fa Updated doc template to link to terms of use 2017-07-13 17:18:42 -07:00
David G Yu
62e1a62842 Release 3.2.0 2017-01-31 13:43:21 -08:00
David G Yu
df0ac0c34f Release 3.1.1 2017-01-09 16:33:08 -08:00
barry
906f3e0c99 Minor changes to 3.1 release documentation:
- fixed dangling links to intro_30.html -- now release_30.html
    - minor changes for consistency and to remove redundancy
2016-10-20 19:53:17 -07:00
David G Yu
6a98ff5bc3 Added Documentation and API notes for 3.1
Updated the 3.1 release overview page to expand the
descriptions of new features and to list API changes.
2016-10-19 12:21:56 -07:00
David G Yu
9c1ae306ea Release 3.1.0 RC2 2016-10-13 21:43:22 -07:00
David G Yu
3957da8e9c Reorganized release specific documentation
With our second substantial release in the 3.x series
we've reorganized the documentation links a bit. This
establishes a more consistent arrangement for release
specific documentation pages.
2016-10-13 17:38:08 -07:00
David G Yu
c7c55ac4d2 Removed roadmap page from the documentation.
The roadmap presented was significantly out of date.
We will find a better way to document work in progress.
2016-10-13 15:28:05 -07:00
David G Yu
f05e01c921 Removed remaining doc for mayaPolySmooth example 2016-10-13 09:28:23 -07:00
David G Yu
0034966af4 Release 3.1.0 RC1 2016-09-30 18:29:51 -07:00
George ElKoura
d856975ef3 No longer use CMAKE_SOURCE_DIR and CMAKE_BINARY_DIR
As mentioned in issue #814, avoiding the use of CMAKE_SOURCE_DIR makes it easier to integrate OpenSubdiv as a submodule in other projects.

Fixes #814.
2016-07-08 22:45:33 -07:00
David G Yu
799b26bba3 Release 3.0.5 2016-03-25 15:15:29 -07:00
David G Yu
4690519424 Release 3.0.4 2016-02-10 16:50:43 -08:00
jcowles
9f0e49edc6 Release 3.0.3 2015-10-05 16:27:09 -07:00
George ElKoura
effe6a2ed6 Fixed small bug in glFVarViewer for Loop.
- Make sure to pass in the LOOP define to the shader when dealing with
Loop surfaces.
2015-08-24 17:33:30 -07:00
David G Yu
b3a2432216 Updated release notes 2015-08-05 12:41:50 -07:00
David G Yu
aa72092222 Updated release notes 2015-08-04 14:27:50 -07:00
David G Yu
fc79fd9e9d Re-categorized some items in release notes
Some of these items are better considered as minor, pro-active changes
rather than bug fixes.
2015-08-03 15:12:52 -07:00
Jeremy Cowles
92b5b03bc7 Merge pull request #723 from davidgyu/releaseUpdate
Updated release notes for 3.0.1
2015-08-03 14:07:10 -07:00
David G Yu
d879907d9f Updated release notes for 3.0.1 2015-08-03 14:01:55 -07:00
David G Yu
69017538ee Fixed author attribution for Loop 2008 AAC paper 2015-08-03 10:40:54 -07:00
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