Commit Graph

283 Commits

Author SHA1 Message Date
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
George ElKoura
aa6ba33281 Getting ready for RC1.
- changed the namespace version
- updated release notes documentation
2015-06-03 20:06:21 -07:00
Takahito Tejima
a7c5179ef9 renaming (2/2) PatchTables and StencilTables to PatchTable and StencilTable
replace all occurrences reffering PatchTables, StencilTables, and their factories.
2015-05-22 11:50:01 -07:00
George ElKoura
8456c703fa Minor fixes to building docs and doc links.
- Upped minimum required version of docutils from 0.6 to 0.9.
- Fixed link to pygments in build documentation
- Fixed link to doxygen in build documentation
2015-04-24 19:16:34 -07:00
jcowles
9ef4be64f0 Updating documentation in readme and far_overview.
Pointing the README build notes to the public web site so there is a single
source of build documentation.

Fixed minor typo in far_overview.
2015-04-12 18:13:23 -07:00
George ElKoura
eab2550300 Updating beta issues in docs. 2015-04-06 22:09:14 -07:00
George ElKoura
5ed669db07 Another handful of minor doc fixes. 2015-04-06 19:41:09 -07:00
George ElKoura
5c623775d5 Fix superscript usage in documentation for far. 2015-04-04 21:50:47 -07:00
George ElKoura
b3d734d84f Minor fixes to release notes. 2015-04-03 23:42:22 -07:00
George ElKoura
61fc019e38 Tiny doc fixes to intro and subdiv sections. 2015-04-03 18:29:10 -07:00
manuelk
2697c31eed Add WIP downloads / EULA documentation page 2015-02-27 16:09:17 -08:00
Nicholas Bishop
3c88851cf6 Fix typo: "buf" -> "bug" 2015-02-25 18:03:41 -08:00
manuelk
862dbfb028 Minor fixes on the documentation splash image 2015-02-03 13:17:34 -08:00
manuelk
8ce16075ca Minor tweak to release notes
- remove language wrt/ changes in vertex boundary interpolation rules :
  enum names were changed, but functionality from 2.x is retained.
2015-01-15 17:15:11 -08:00
manuelk
a2c7c49bd3 Add content / fix typos to modeling tips ReST documentation 2015-01-15 12:03:35 -08:00
manuelk
99843dc650 Adding modeling tips to ReST documentation 2015-01-14 18:11:10 -08:00
manuelk
7c26ba176b Update roadmap document 2015-01-09 13:01:22 -08:00
barfowl
0b7ba6a604 Minor updates to documentation preceding Beta release. 2015-01-08 19:07:35 -08:00
manuelk
2aed68de1e Fix typos in ReST docs 2015-01-07 10:52:08 -08:00
manuelk
8d86a2c6bd WIP doxyfication of Sdc 2014-12-22 11:29:15 -08:00
manuelk
5faa961bf6 Update release notes & documentation for upcoming Beta release 2014-12-19 11:32:23 -08:00
manuelk
5214a6d2ab Update subdivision ReST documentation to match changes in Sdc 2014-12-18 11:14:19 -08:00
manuelk
ff223e4aaf Fix documentation code highlighing
- remove underlines from css on class names
2014-12-04 11:30:22 -08:00
manuelk
9b3f25df2c Adding git URL to html tutorial documentation 2014-12-01 18:49:51 -08:00
manuelk
ead2aa97a4 Fix URL in documentation 2014-12-01 16:48:25 -08:00
manuelk
a8ee36ae33 Add automatic ReST pages to the documentation for the tutorials code
- add python script to generate ReST from the C++ tutorial source files
- add css stylesheet for C++ syntax highlighting (based on my nedit settings)
- add functionality to CMake build to make it all happen
- add hyperlinks to tutorials.rst file
2014-12-01 15:52:58 -08:00
manuelk
c10e18a035 Add cascading stencils Far tutorial 2014-11-18 16:52:32 -08:00
manuelk
58c8accbe9 WIP ReST documention for Far::StencilTables 2014-11-18 15:55:14 -08:00
manuelk
c6306b42c4 Documenation update
- add licensing information page
- add roadmap page
- minor tweaks to intro page
- small fix to navigation bar css
2014-11-13 13:57:34 -08:00
manuelk
ac34609420 Reformatting navigation bar in ReST documentation to add Github button 2014-10-27 14:31:04 -07:00
manuelk
0d4582b34c Add 'sticles' to the glEvalLimit code example
Make the sample locations dynamic by adding a velocity vector. Face boundary
crossing is handled using the new ptex adjacency functionality recently
added to the Far::TopologyRefiner.
2014-09-30 18:53:47 -07:00
manuelk
f7b21b941c Add far_tutorial_6 showing how to interpolate primvar data on the surface
limit at arbitrary locations.
2014-09-22 13:51:59 -07:00
manuelk
fe0cb3a3d4 Update documentation images of some gl code examples (glViewer, glEvalLimit, glStencilViewer) 2014-09-17 18:29:25 -07:00
manuelk
743b58d99b WIP Far::PatchTables documentation 2014-09-08 14:05:21 -07:00
manuelk
c399655dcc Landing 3.0.0.alpha
Sync'ing the 'dev' branch with the 'feature_3.0dev' branch at commit 68c6d11fc36761ae1a5e6cdc3457be16f2e9704a

The branch 'feature_3.0dev' is now locked and preserved for historical purposes.
2014-09-05 15:07:46 -07:00
manuelk
942957a5e7 Update release notes for release 2.6.0 2014-08-19 11:41:16 -07:00
manuelk
9f38860806 Update release notes for release 2.5.1 2014-06-19 15:51:44 -07:00
manuelk
8d877d720b Update release notes for release 2.5.0 2014-05-28 16:35:05 -07:00
Sergey Sharybin
6ef232c95a Integrate CLEW into osd library and examples
If the system has CLEW installed (which is detected by recently
added FindCLEW routines) then OpenSubduv would be compiled against
this library.

It makes binaries and libraries more portable across the systems,
so it's possible to run the same binary on systems with and without
OpenCL SDK installed.

The most annoying part of the change is updating examples to load
OpenCL libraries, but ideally code around controllers and interface
creation is to be de-duplicated anyway.

Based on the pull request #303 from Martijn Berger
2014-05-22 09:10:59 +02:00
Sergey Sharybin
5cafd6c40e Make PTex support optional
Basically makes configuration log much cleaner on systems
where PTex is not installed.
2014-05-17 12:46:39 -07:00
Sergey Sharybin
575cb30e54 Document NO_MAYA command line option
If was used in CMake but was never documented.
2014-05-17 12:45:37 -07:00
Sergey Sharybin
28e3431aa9 Add an option to disable OpenCL
It's not always wanted to compile OpenSubdiv with OpenCL
support when the SDK is installed on the builder machine.
2014-05-17 12:43:25 -07:00
manuelk
b643c28b99 Update release notes for release 2.4.1 2014-04-21 12:18:16 -07:00
manuelk
88c2448db0 Update release notes for release 2.4.0 2014-04-16 11:29:10 -07:00
manuelk
1bb174e654 Update dxViewer example documentation
fixes #276
2014-04-14 12:08:59 -07:00
mkraemer
05a7db5e14 Make CMake path variables more robust
Add quotes around variables containing paths - this might require a second pass...

fixes #258
2014-04-09 16:43:38 -04:00
mkraemer
5cef906014 Adding documentation content
- Hierarchical edits descriptions
- Uniform vs Adaptive feature comparison
2014-04-09 11:20:59 -04:00
manuelk
a9f321482a Update release notes for release 2.3.5 2014-03-17 11:41:58 -07:00
manuelk
a2563f3c2d Adding documentation (face-varying boundary interpolation rules) 2014-02-25 17:08:22 -08:00
manuelk
2a4b1329c1 Adding documentation (boundary interpolation rules) 2014-02-25 15:27:12 -08:00
manuelk
a4bd2dee1d Update documention for Xcode builds 2014-02-20 11:05:09 -08:00
manuelk
14908b737c Update release notes for release 2.3.4 2014-01-13 10:52:17 -08:00
manuelk
14f5d60af9 Update release notes for release 2.3.3 2013-12-05 11:12:38 -08:00
manuelk
b3b2e56a26 Adding recommended isolation output to OsdPolySmooth node.
- added attribute to the maya example node
- added AE template for editor display
- added ReSt documentation for the plugin
2013-11-25 17:12:57 -08:00
manuelk
c3cb17fa99 Modify Far remapping of singular vertices to point to their source vertex.
- Add a vector of index pairs to HbrMesh to track the index of a split
  vertex and its origin vertex
- Correct the Far remap tables in FarSubdivisionTablesFactory to point split
  vertices to their origin instead of themselves
- Fix regression/common/shape_utils.h to use the new HbrMesh::GetSplitVertices()
  method.
- Fix the osdPolySmooth example to use the new HbrMesh::GetSplitVertices()
  method.
- Add a paragraph to the documentation

fixes #241
2013-11-21 16:05:31 -08:00
manuelk
32fe4c54a4 Adding some documentation for Chaikin crease rule 2013-11-18 15:56:07 -08:00
manuelk
beecafbd35 Update release notes for release 2.3.2 2013-11-15 15:12:34 -08:00
manuelk
83d9315e64 Fix Chaikin tag parsing
Also:
- add 2 shape examples with Chaikin rule tag
- add shapes to the glViewer
- add a stub in the documentation

Note: the Chaikin rule currently applied by Hbr appears to be somewhat off...

fixes #236
2013-11-01 11:38:20 -07:00
manuelk
ccbfdf71fb Update release notes 2013-10-30 12:06:56 -07:00
manuelk
a68bad450d Addding some video links to our collection of external resources. 2013-10-28 10:10:03 -07:00
manuelk
c637a1f912 Update release notes 2013-09-27 13:27:08 -07:00
manuelk
3a5787ac10 Add a note in the documentation about disabling offsetof warning.
Because client code inlines Hbr, this warning is spurriously triggered by
several compilers and needs to be disabled within the client code build system.

fixes #227
2013-09-27 10:53:56 -07:00
manuelk
6eb4bdf87b Adding documentation for the uvViewer example 2013-09-26 16:23:18 -07:00
manuelk
3ae50d1c50 Amending Apache license language & file headers.
New text:

     Copyright 2013 Pixar

     Licensed under the Apache License, Version 2.0 (the "Apache License")
     with the following modification; you may not use this file except in
     compliance with the Apache License and the following modification to it:
     Section 6. Trademarks. is deleted and replaced with:

     6. Trademarks. This License does not grant permission to use the trade
        names, trademarks, service marks, or product names of the Licensor
        and its affiliates, except as required to comply with Section 4(c) of
        the License and to reproduce the content of the NOTICE file.

     You may obtain a copy of the Apache License at

         http://www.apache.org/licenses/LICENSE-2.0

     Unless required by applicable law or agreed to in writing, software
     distributed under the Apache License with the above modification is
     distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     KIND, either express or implied. See the Apache License for the specific
     language governing permissions and limitations under the Apache License.
2013-09-26 12:04:57 -07:00
manuelk
b60c9eec12 Correct vertex boundary interpolation rules doc
(hopefully i got it right at last...)
2013-09-20 10:49:50 -07:00
manuelk
fbea764170 Add a figure to the vertex boundary interpolation doc 2013-09-20 10:39:05 -07:00
manuelk
c12e3a0f38 Fix boundary interpolation rules doc 2013-09-18 14:17:33 -07:00
David Aguilar
55c0b0d70f Install documentation into share/doc/opensubdiv/
Per the Filesystem Hierarchy Standard:

http://www.pathname.com/fhs/pub/fhs-2.3.html#SPECIFICOPTIONS15
2013-09-16 18:40:17 -07:00
Manuel Kraemer
cf847df9e8 Adding external documentation links
Adding a page to link to videos, tutorials, blogs...
2013-09-14 08:34:27 -07:00
manuelk
7d4999c46e Adding support for subdivision stencils.
- Adding FarStencilTables and FarStencilTablesFactory classes
- Adding Osd EvalStencil context & controllers for CPU, OMP and TBB backends
- Adding the code example glStencilViewer
- Adding reST documentation
- Changing version to 2.2.0_dev
- Fix HbrMesh::Unrefine function
- Fix "CanEval" function in OsdVertexBufferDescriptor

Note 0: there is no stencil support for hierarchical edits

Note 1: there is no support for face-varying data stencils yet

Note 2: the current stencil factory is lazy but the caching system is not re-entrant
2013-09-11 16:05:14 -07:00
manuelk
2211bf456c Update release notes 2013-09-03 15:41:34 -07:00
manuelk
1e69dbe630 Update release notes 2013-09-03 10:22:12 -07:00
manuelk
37b54f928a doc fix : the correct git branch switching command is 'git checkout <branch>' 2013-08-28 12:02:38 -07:00
manuelk
d57df0eae0 Enable TBB for Linux builds
- Fix FindTBB.cmake
- Add TBB logic to various CMakeLists
- Update documentation
2013-08-15 16:11:33 -07:00
manuelk
b81d159b91 Enabling Intel's C++ Studio XE icc compiler in Linux
- Add a ICC_LOCATION option to CMake configuration
- Fix icc dependencies
- Add documentation
2013-08-15 15:21:00 -07:00
manuelk
c498d4b53a Documentation : updating release notes 2013-08-07 11:45:24 -07:00
manuelk
a30101482a Adding release notes for 2.0.1 2013-08-07 10:37:27 -07:00
manuelk
4585b599c1 update documentation & CLA files to reflect Apache 2.0 move
fixes #138
2013-08-01 16:14:23 -07:00
manuelk
94fc47a9db adding Osd documentation based on Siggraph slides
fixes #138
2013-07-29 19:14:19 -07:00
manuelk
ba9870ec02 Updating release notes 2013-07-18 15:43:16 -07:00
manuelk
ed090214d5 Updating EULA 2013-07-18 15:11:47 -07:00
manuelk
f56bb2cf50 Updating EULA 2013-07-18 15:05:24 -07:00
Susan Salituro
20993694ec Changing OS main site links to be absolute, not relative 2013-07-18 14:29:06 -07:00
Takahito Tejima
51a45b598d Updating EULA 2013-07-18 14:19:50 -07:00
Susan Salituro
a6fc3d935b Applying OpenSubdiv site template to docs. 2013-07-18 11:26:54 -07:00
manuelk
46c385ef1a adding documentation content 2013-07-18 09:52:31 -07:00
manuelk
71d55db586 adding reST documentation content 2013-07-18 09:01:51 -07:00
manuelk
500defee4c - adding new build flag options (NO_LIB, NO_CUDA...)
- move python build section into the python directory (cleaning up)

- fix some broken dependencies

- remove the public_headers targets if doxygen was not found

TODO :
- fix MSVC targets for public headers (wbn if MSVC didn't require the pro version
  in order to support solution folders)
- fix osd_regression to not build if -DNO_LIB is present (ie. fix the broken dependency)
2013-07-11 18:55:17 -07:00
manuelk
12d67bfbcb - fixing comments in Far for better Doxygen readability
(first pass - more work needs to be done)
2013-07-10 18:51:43 -07:00
manuelk
f079e57f96 Fix doc build
- turn the _add_doxy_headers macro into a no-op if -DNO_DOC is used
  so it doesn't cause problems

- moved the -DNO_DOC conditional into the top CMakeLists file, following
  pattern with other override flags
2013-07-09 10:00:40 -07:00
Manuel Kraemer
bf378b16a5 Intermediate documentation check-in
- changes to the documentation build
- added content & images
- style changes
2013-07-07 18:20:46 -07:00
manuelk
a0ba18a6d6 intermediate documentation check-in : adding content 2013-07-05 18:41:04 -07:00
manuelk
9712b44239 Documentation build modifications:
- add macro "_add_doxy_headers" in order to track all header files elligible for
  doxygen documenation. This captures public header files that would otherwise be
  excluded from installation because they are not supported by the OS. Private
  header files remain excluded though.

- add custom targets and commands so that documentation build produces functioning
  RST and Doxygen documentation both in the build and install stages

- switched to Doxygen 1.8 (because markdown will make in-lined documentation easier)

- added build switches to disable examples, regression and python-SWIG targets

- fixed doxygen link in the nav bar

- modified python html processing tool to match Cmake changes
2013-07-05 15:36:54 -07:00
Manuel Kraemer
7a71def44a Adding more documentation
- new RST pages for our excample code
- fix doxygen documentation link from the nav tab
- fix cmake build rules (still not quite working as intended)
- adding API RST documentation all around
2013-07-04 19:17:34 -07:00
manuelk
e3109ae507 Incremental commit for the new HTML documentation system:
- adding docutils cmake module
- adding rst2html conversion build step to our documentation folder
- adding tipue search system
- adding a python script to insert HTML navigation template and index HTML documentation contents
- adding RST documentation content, images and temporary CSS styling
2013-07-04 10:47:56 -07:00
manuelk
b815aff333 First pass at fixing the installation part of the Cmake build : now CMAKE_INSTALL_PREFIX can
be used as intended to specify an installation directory, which can be located anywhere on the
file system.

Also improved the doxygen target and made the doxy build "quiet".

fixes #154
2013-04-22 19:35:41 -07:00
manuelk
7c10b9c321 minor cleanup of doxygen cmake rules 2013-02-08 14:32:01 -08:00
manuelk
10c687ecd5 Release Candidate 1.0 :
- [Feature Adaptive GPU Rendering of Catmull-Clark Surfaces](http://research.microsoft.com/en-us/um/people/cloop/tog2012.pdf).

- New API architecture : we are planning to lock on to this new framework as the basis for backward compatibility, which we will enforce from Release 1.0 onward. Subsequent releases of OpenSubdiv should not break client code.

- DirectX 11 support

- and much more...
2012-12-10 17:15:13 -08:00
Manuel Kraemer
7fd99b421f Taking a first stab at a doxygen config file and matching cmake rules.
Also reformatting a chunk of FAR's comments to work w/ doxygen.

Closes #75
2012-10-06 17:53:51 -07:00