mirror of
https://github.com/PixarAnimationStudios/OpenSubdiv
synced 2025-01-03 13:41:06 +00:00
made README a bit more readable
* removed not needed formatting * removed space before colons * removed not needed space between sentences * added link to "Pixar Graphics Technologies" * added link to "Microsoft Public License" * added link to "SIGGRAPH 2012" * fixed code blocks and their introduction * use inline code for configuration option names
This commit is contained in:
Jan Pieper
parent
e298d1706f
commit
180d5a112c
114
README.md
114
README.md
@ -1,88 +1,94 @@
|
||||
# OpenSubdiv #
|
||||
# OpenSubdiv
|
||||
|
||||
OpenSubdiv is a set of open source libraries that implement high performance subdivision surface (subdiv) evaluation on massively parallel CPU and GPU architectures. This codepath is optimized for drawing deforming subdivs with static topology at interactive framerates. The resulting limit surface matches Pixar’s Renderman to numerical precision.
|
||||
|
||||
OpenSubdiv is covered by the Microsoft Public License, and is free to use for commercial or non-commercial use. This is the same code that Pixar uses internally for animated film production. Our intent is to encourage high performance accurate subdiv drawing by giving away the “good stuff”.
|
||||
OpenSubdiv is covered by the [Microsoft Public License](http://www.microsoft.com/en-us/openness/licenses.aspx#MPL), and is free to use for commercial or non-commercial use. This is the same code that Pixar uses internally for animated film production. Our intent is to encourage high performance accurate subdiv drawing by giving away the "good stuff".
|
||||
|
||||
OpenSubdiv is entering open beta for SIGGRAPH 2012. Feel free to use it and let us know what you think.
|
||||
OpenSubdiv is entering open beta for [SIGGRAPH 2012](http://s2012.siggraph.org/). Feel free to use it and let us know what you think.
|
||||
|
||||
For more details about OpenSubdiv, see http://graphics.pixar.com
|
||||
For more details about OpenSubdiv, see [Pixar Graphics Technologies](http://graphics.pixar.com).
|
||||
|
||||
Note that this beta code is live and will undergo significant churn as it approaches release. Expect that APIs will change as the code is continually improved.
|
||||
Note that this beta code is live and will undergo significant churn as it approaches release. Expect that APIs will change as the code is continually improved.
|
||||
|
||||
|
||||
## Quickstart ##
|
||||
## Quickstart
|
||||
|
||||
Basic instructions to get started with the code.
|
||||
|
||||
### Dependencies ###
|
||||
### Dependencies
|
||||
|
||||
Required :
|
||||
* IlmBase 1.0.1 : http://www.openexr.com/downloads.html
|
||||
Required:
|
||||
* IlmBase 1.0.1: http://www.openexr.com/downloads.html
|
||||
|
||||
Optional :
|
||||
Optional:
|
||||
* Maya SDK (sample code for Maya viewport 2.0 primitive)
|
||||
|
||||
### Build instructions for linux : ###
|
||||
### Build instructions for linux:
|
||||
|
||||
<pre><code>
|
||||
* clone the repository :
|
||||
mkdir git
|
||||
cd git
|
||||
git init
|
||||
git clone git://github.com/PixarAnimationStudios/OpenSubdiv.git
|
||||
__Clone the repository:__
|
||||
|
||||
* generate Makefiles :
|
||||
cd OpenSubdiv
|
||||
mkdir build
|
||||
cd build
|
||||
cmake ..
|
||||
* build the project :
|
||||
make
|
||||
</code></pre>
|
||||
````
|
||||
mkdir git
|
||||
cd git
|
||||
git init
|
||||
git clone git://github.com/PixarAnimationStudios/OpenSubdiv.git
|
||||
````
|
||||
|
||||
### Useful cmake options and environment variables ###
|
||||
__Generate Makefiles:__
|
||||
|
||||
<pre><code>
|
||||
````
|
||||
cd OpenSubdiv
|
||||
mkdir build
|
||||
cd build
|
||||
cmake ..
|
||||
````
|
||||
|
||||
__Build the project:__
|
||||
|
||||
````
|
||||
make
|
||||
````
|
||||
|
||||
### Useful cmake options and environment variables
|
||||
|
||||
````
|
||||
-DCMAKE_BUILD_TYPE=[Debug|Release]
|
||||
|
||||
-DILMBASE_LOCATION=[path to IlmBase]
|
||||
|
||||
-DMAYA_LOCATION=[path to Maya]
|
||||
|
||||
-DPTEX_LOCATION=[path to Ptex]
|
||||
|
||||
-DGLUT_LOCATION=[path to GLUT]
|
||||
|
||||
-DGLEW_LOCATION=[path to GLEW]
|
||||
</code></pre>
|
||||
````
|
||||
|
||||
The paths to Maya, Ptex, GLUT, and GLEW can also be specified through the
|
||||
following environment variables: MAYA_LOCATION, PTEX_LOCATION, GLUT_LOCATION,
|
||||
and GLEW_LOCATION.
|
||||
following environment variables: `MAYA_LOCATION`, `PTEX_LOCATION`, `GLUT_LOCATION`,
|
||||
and `GLEW_LOCATION`.
|
||||
|
||||
### Standalone viewer ###
|
||||
### Standalone viewer
|
||||
|
||||
<pre><code>
|
||||
* To run viewer:
|
||||
bin/viewer
|
||||
* Usage:
|
||||
Left mouse button drag : orbit camera
|
||||
Middle mouse button drag : dolly camera
|
||||
Right mouse button : show popup menu
|
||||
n, p : next/prev model
|
||||
1, 2, 3, 4, 5, 6, 7 : specify subdivision level
|
||||
w : switch display mode
|
||||
q : quit
|
||||
</code></pre>
|
||||
__To run viewer:__
|
||||
|
||||
````
|
||||
bin/viewer
|
||||
````
|
||||
|
||||
## Wish List ##
|
||||
__Usage:__
|
||||
|
||||
````
|
||||
Left mouse button drag : orbit camera
|
||||
Middle mouse button drag : dolly camera
|
||||
Right mouse button : show popup menu
|
||||
n, p : next/prev model
|
||||
1, 2, 3, 4, 5, 6, 7 : specify subdivision level
|
||||
w : switch display mode
|
||||
q : quit
|
||||
````
|
||||
|
||||
## Wish List
|
||||
|
||||
There are many things we'd love to do to improve support for subdivs but don't have the resources to. We hope folks feel welcome to contribute if they have the interest and time. Some things that could be improved:
|
||||
|
||||
There are many things we'd love to do to improve support for subdivs but don't have the resources to. We hope folks feel welcome to contribute if they have the interest and time. Some things that could be improved:
|
||||
* The reference maya plugin doesn't integrate with Maya shading. That would be cool.
|
||||
* John Lasseter loves looking at film assets in progress on an iPad. If anyone were to get this working on iOS he'd be looking at your code, and the apple geeks in all of us would smile.
|
||||
* John Lasseter loves looking at film assets in progress on an iPad. If anyone were to get this working on iOS he'd be looking at your code, and the apple geeks in all of us would smile.
|
||||
* Alembic support would be wonderful, but we don't use Alembic enough internally to do the work.
|
||||
* The precomputation step with hbr can be slow. Does anyone have thoughts on higher performance with topology rich data structures needed for feature adaptive subdivision? Maybe a class that packs adjacency into blocks of indices efficiently, or supports multithreading, or even feature-adaptive subdivision on the GPU?
|
||||
|
||||
|
||||
* The precomputation step with hbr can be slow. Does anyone have thoughts on higher performance with topology rich data structures needed for feature adaptive subdivision? Maybe a class that packs adjacency into blocks of indices efficiently, or supports multithreading, or even feature-adaptive subdivision on the GPU?
|
||||
Loading…
Reference in New Issue
Block a user