VRay SDK for C#
Loading...
Searching...
No Matches
VRay.RenderElements Class Reference

This class groups methods related to management of render elements in the scene More...

Public Types

enum  RGBOrder
 Specifies the RGB order of the data returned by render elements' data APIs.
 

Public Member Functions

RenderElement Add (RenderElementType type, string instanceName, string displayName)
 Attempts to create a new render element. More...
 
RenderElement Get (RenderElementType type)
 Returns the first render element of the specified type. More...
 
IEnumerable< RenderElementGetAll (RenderElementType type)
 Returns all render elements of the specified type. If type is NONE, all render elements of all types will be returned. More...
 

Detailed Description

This class groups methods related to management of render elements in the scene

Member Function Documentation

◆ Add()

RenderElement VRay.RenderElements.Add ( RenderElementType  type,
string  instanceName,
string  displayName 
)

Attempts to create a new render element.

Parameters
typeThe type of render element. Some types allow more than one instance.
instanceNameAn optional name to show in the VFB. If null, a default name will be used.
displayNameAn optional name for the plugin instance that will be created.
Returns
null if unable to create the render element

◆ Get()

RenderElement VRay.RenderElements.Get ( RenderElementType  type)

Returns the first render element of the specified type.

Parameters
typeRender element type

◆ GetAll()

IEnumerable< RenderElement > VRay.RenderElements.GetAll ( RenderElementType  type)

Returns all render elements of the specified type. If type is NONE, all render elements of all types will be returned.

Parameters
typeRender element type. Use NONE to get any type of render element

The documentation for this class was generated from the following file: