Classes | Modules
Light Illumination Data

Classes

struct   xsimrLightIllumData
  If set by a shader, will be filled in by Softimage's light shaders to contain a separated light and shadow information. Also contains the amount of contribution this light gives to the diffuse and specular components of the shading model. More...

Modules

  RenderMap Define
#define  XSIMR_LIGHTILLUMDATA_KEY   "xsiLID"
#define  XSIMR_RENDERMAPDATA_LABEL   0x2C1ACA
enum   xsimrCurveExtrapolation {
  XSIMR_CE_CONSTANT = 1,
  XSIMR_CE_END_GRADIENT = 2,
  XSIMR_CE_CYCLE = 3,
  XSIMR_CE_CYCLE_RELATIVE = 4
}
enum   xsimrParticleShapeType {
  xsimrSHAPE_POINT,
  xsimrSHAPE_SEGMENT,
  xsimrSHAPE_DISC,
  xsimrSHAPE_RECTANGLE,
  xsimrSHAPE_SPHERE,
  xsimrSHAPE_BOX,
  xsimrSHAPE_CYLINDER,
  xsimrSHAPE_CAPSULE,
  xsimrSHAPE_CONE,
  xsimrSHAPE_BLOB,
  xsimrNB_SIMPLE_SHAPES,
  xsimrSHAPE_INSTANCE = 128
}

Detailed Description

In mental ray, light shaders usually return a combined light color and shadowing information. To get a separated information from the light, a shader calling the light sampling functions can initialise this structure and pass it to the light shader using mi_shaderstate_set with the key value of XSIMR_LIGHTILLUMDATA_KEY. The light shader, if successful, will fill in the appropriate information in the structure.

Since:
8.0 (2010)

Define Documentation

#define XSIMR_LIGHTILLUMDATA_KEY   "xsiLID"

The key value to use to attach the data structure to the shader state

#define XSIMR_RENDERMAPDATA_LABEL   0x2C1ACA

The magic number for querying rendermap userdata from a mental ray shader.


Enumeration Type Documentation

Enumerator:
XSIMR_CE_CONSTANT 

The values of the end points extend to infinity

XSIMR_CE_END_GRADIENT 

The end segments extend to infinity

XSIMR_CE_CYCLE 

The curve cycles indefinitely in both directions, each curve starting on the same value

XSIMR_CE_CYCLE_RELATIVE 

The curve cycles indefinitely in both directions, but each curve after the original starts on the end point of the previous curve, and each curve before ends on the start point of the next.

xsimrParticleShapeType xsimrParticleShapeType Enum Defines the particle shape types for rendering.

See also:
xsimrParticleShape, xsimrPointCloudData, xsimrAttributeData
Since:
7.0
Enumerator:
xsimrSHAPE_POINT 

Point type.

xsimrSHAPE_SEGMENT 

Segment type.

xsimrSHAPE_DISC 

Disc type.

xsimrSHAPE_RECTANGLE 

Rectangle type.

xsimrSHAPE_SPHERE 

Sphere type.

xsimrSHAPE_BOX 

Box type.

xsimrSHAPE_CYLINDER 

Cylinder type.

xsimrSHAPE_CAPSULE 

Capsule type.

xsimrSHAPE_CONE 

Cone type.

xsimrSHAPE_BLOB 

Blob type.

xsimrNB_SIMPLE_SHAPES 

Simple shape type.

xsimrSHAPE_INSTANCE 

Instance type.