vrayΒΆ

V-Ray Python Binding Module

V-Ray is exposed mainly through the VRayRenderer class. There is also VRayServer for distributed rendering. VRayImage encapsulates rendered images. Plugin objects represent instances of V-Ray scene objects and give R/W access to their data.

Special module-level function: setSDKLibraryPath(string) - you have to call this with the path to VRaySDKLibrary.dll BEFORE calling any other functions if you have not set the VRAY_SDK environment variable.

Constants:

from VRayRenderer.onStateChanged and VRayRenderer.state:

  • RENDERER_STATE_FATAL_ERROR - Fatal exception occured. Should always save and restart.

  • RENDERER_STATE_IDLE_INITIALIZED - Initial state after construction or clearing.

  • RENDERER_STATE_IDLE_STOPPED - Rendering was interrupted by stop() or from the UI.

  • RENDERER_STATE_IDLE_ERROR - Rendering was aborted due to an error.

  • RENDERER_STATE_IDLE_FRAME_DONE - Waiting for continueSequence between the frames of an animation sequence.

  • RENDERER_STATE_IDLE_DONE - Last rendering was completed successfully.

  • RENDERER_STATE_PREPARING - Preparing to start rendering the scene.

  • RENDERER_STATE_RENDERING - Rendering is ongoing. This may be any mode of rendering and any stage such as a prepass.

  • RENDERER_STATE_RENDERING_PAUSED - Interactive rendering has been paused.

  • RENDERER_STATE_RENDERING_AWAITING_CHANGES - Interactive rendering reached target quality or time limit, but keepInteractiveRunning is true.

from VFB.getState and for VFB.setState:

  • VFB_STATE_MAIN - enable use of main VFB window state

  • VFB_STATE_HISTORY - enable use of VFB History state

  • VFB_STATE_ALL - enable use of all VFB state

for scanned material parameters:

  • SCANNED_MATERIAL_PLAIN_NONE

  • SCANNED_MATERIAL_PLAIN_HOMOGENOUS

  • SCANNED_MATERIAL_PLAIN_HOMOGENOUS_SYMMETRIC

  • SCANNED_MATERIAL_PLAIN_SCRAMBLE

  • SCANNED_MATERIAL_CHANNEL_PAINT_BITMASK

  • SCANNED_MATERIAL_CHANNEL_FILTER_BITMASK

  • SCANNED_MATERIAL_CHANNEL_CCMULT_BITMASK

  • SCANNED_MATERIAL_COLOR_SPACE_SRGB

  • SCANNED_MATERIAL_COLOR_SPACE_ADOBE

  • SCANNED_MATERIAL_COLOR_SPACE_PRO_PHOTO

mode for VRayRenderer.setVRayProfiler():

  • PROFILER_MODE_OFF

  • PROFILER_MODE_SIMPLE

  • PROFILER_MODE_FULL

  • PROFILER_MODE_PROCESS

flags for Proxy.readFullData and Proxy.readPreviewData:

  • READ_FLAGS_MESH_VERTICES

  • READ_FLAGS_MESH_NORMALS

  • READ_FLAGS_MESH_MTLIDS

  • READ_FLAGS_MESH_VELOCITIES

  • READ_FLAGS_MESH_UVS

  • READ_FLAGS_MESH_SHADERS

  • READ_FLAGS_MESH_OBJECTINFOS

  • READ_FLAGS_MESH_HAIROBJECTINFOS

  • READ_FLAGS_MESH_PARTICLEOBJECTINFOS

  • READ_FLAGS_MESH_HAIRGEOMETRY

  • READ_FLAGS_MESH_PARTICLESGEOMETRY

  • READ_FLAGS_MESH_GEOMETRYMESHESBBOXES

  • READ_FLAGS_MESH_HAIROBJECTBBOXES

  • READ_FLAGS_MESH_PARTICLEOBJECTBBOXES

  • READ_FLAGS_MESH_ALL

Classes

AColor

An extension of vray.Color that adds an alpha channel as the 4th component.

BinUserAttributesWriter

A class used to binary serialize user attributes to V-Ray IntList.

Category()

V-Ray Plugin Category

Class()

V-Ray Plugin Class

Color

A 3-component floating point color value.

ColorList

Efficient implementation of V-Ray ColorList.

FloatList

Efficient implementation of V-Ray FloatList.

GeomUtils()

A group of utility methods related to variuos geometry source plugins.

IntList

Efficient implementation of V-Ray IntList.

Language()

Static utility class with language constants

LightUtils()

A group of utility methods related to variuos light source plugins.

Matrix

A 3x3 column-major matrix.

OCIOConfigurationData

Object storing the relevant OCIO configuration entries as they were read from the configuration file.

Plugin()

A wrapper for a Plugin instance in the V-Ray core.

PluginList

Efficient implementation of V-Ray PluginList.

PluginRef()

PluginRef wraps a plugin instance along with a property output of the plugin.

Proxy()

A group of methods for reading data and creating V-Ray geometry proxies.

Renderer

alias of vray.VRayRenderer

ScannedMaterialInfo

A class used to get information string and preset values from a scanned material file.

Server

alias of vray.VRayServer

Transform

The object is a composite of a vray.Matrix and a vray.Vector that represent an affine transformation.

TransformList

Efficient implementation of V-Ray TransformList.

TypedList()

The base abstract type of IntList, FloatList, VectorList, ColorList, TransformList and PluginList.

Util()

Static class for utility helper methods.

VFB()

A namespace-like class for VFB related methods.

VRMat

This class groups a few functions for work with .vrmat (.vismat) materials.

VRayImage

Contains raw image data in full 32-bit floating point format.

VRayRenderer

This is the main object in V-Ray.

VRayServer

A server object for distributed rendering.

Vector

A mathematical vector in 3D space.

VectorList

Efficient implementation of V-Ray VectorList.