FBRenderOptions Class Reference

List of all members.

Public Member Functions

 __init__ (HKRenderOptions pOptions)
FBCamera GetRenderingCamera ()
 Get the rendering camera.
int GetRenderFrameId ()
 Get Render Frame ID.
bool IsIDBufferPicking ()
 Get IDBuffer Rendering request status (for display or picking).
bool IsIDBufferRendering ()
 Get IDBuffer Rendering request status (for display or picking).
float GetIDBufferPickingAlphaThreshold ()
 Get IDBuffer Picking Alpha threshold.
bool IsOfflineRendering ()
 Check if the render request comes from offline render mode (as opposed to viewport refresh).
FBViewingOptions GetViewerOptions ()

Public Attributes

HKRenderOptions mRenderOptions
 Pointer to render options.

Member Function Documentation

__init__ ( HKRenderOptions  pOptions)
FBCamera GetRenderingCamera ( )

Get the rendering camera.

int GetRenderFrameId ( )

Get Render Frame ID.

Returns:
This return a new ID each time a new frame is drawn.
bool IsIDBufferPicking ( )

Get IDBuffer Rendering request status (for display or picking).

Deprecated:
As the function name is confuing, use IsIDBufferRendering() instead.
Returns:
true if need to render Model (or subitem)'s UniqueColorID into GL Color Buffer.
bool IsIDBufferRendering ( )

Get IDBuffer Rendering request status (for display or picking).

Returns:
true if need to render Model (or subitem)'s UniqueColorID into GL Color Buffer.
float GetIDBufferPickingAlphaThreshold ( )

Get IDBuffer Picking Alpha threshold.

Returns:
ID Buffer picking alpha threshold value.
bool IsOfflineRendering ( )

Check if the render request comes from offline render mode (as opposed to viewport refresh).

Returns:
true if the render comes from offline render mode.

Member Data Documentation

HKRenderOptions mRenderOptions

Pointer to render options.


FBRenderOptions FBRenderOptions FBRenderOptions FBRenderOptions FBRenderOptions FBRenderOptions FBRenderOptions FBRenderOptions FBRenderOptions FBRenderOptions
FBRenderOptions FBRenderOptions FBRenderOptions FBRenderOptions FBRenderOptions FBRenderOptions FBRenderOptions FBRenderOptions FBRenderOptions FBRenderOptions