C[CS]?ycles : CCycles and CSycles for Cycles

C[CS]?ycles aims to provide a C API around Cycles. Building on CCycles also a C# wrapper is available.

Note 1 Cycles code is now pulled from upstream developer.blender.org. This is done through submodule, so after cloning be sure you init and pull for the submodule as well to get all changes. On subsequent pulls on master you'll have to cd into cycles/ and pull there as well.

Note 2 Boost 1.60.0 has been tested in the master branch. Download it from http://boost.org and extract it to the root of this repository. The folder should be called boost/.

Note 3 This is currently targeted at Windows 64bit platform only, but patches to improve cross-platform compiling and executing are likely candidates for acceptance

Note 4 The grand plan is to improve CCycles and CSycles and prepare for submission to Blender upstream repository. There are still many hurdles to jump over before this project is ready for that. Until that moment main development of both parts is conducted in this repository.

Note 5 No OSL support effort has been made, as for the RhinoCycles plugin the focus is on CUDA support.

Note 6 The C[CS]?ycles main developer is Nathan Letwory. You can contact him at nathan@mcneel.com or find him as jesterKing in IRC channel #blendercoders of the Freenode network.

ROADMAP / TODO

See Notes above, most are TODO items that need to be tackled in a useful way before C[CS]?ycles is ready for upstream. In addition:

• Add the rest of shader and texture nodes
• Documentation
• Documentation
• Improve csycles_tester to do complete XML support

Cycles and dependencies

This folder contains the Cycles source code, C-API source code, C# wrapper source code and source code for the necessary dependencies pthreads, glew, clew, cuew and a modified OpenImageIO.

The Cycles source

The Cycles source code is added as a sub-module at the root of this repository.

OpenImageIO tools

Only a small part of the OpenImageIO library is used on the Rhino version of Cycles. Image loading is handled by Rhino existing image code. The OpenImageIO DLL is named OpenImageIOv13.dll.

pthreads

pthreads contains the threading library used by Cycles. The library is compiled as a DLL.

clew

clew is the OpenCL execution wrangler library

cuew

cuew is the CUDA execution wrangler library

C-API and C# wrapper code

ccycles (C API) csycles (C# wrapper around CCycles) csycles_tester (C# tester program, reimplementation of Cycles standalone) csycles_diag (C# diagnostics program, text output only)

Building

1. Clone repository, init submodule and pull cycles code as well
2. Get Boost and extract it to the root of the repository, rename the folder to boost/
3. Open cycles.sln
4. Build solution for csycles_tester
5. run csycles_tester with an XML test file

License for CCycles and CSycles

Copyright 2014 Robert McNeel and Associates

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

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

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.