Python Reference Guide
 
Loading...
Searching...
No Matches
FBRenderOptions Class Reference

#include <pyfbsdk_generated.h>

Inheritance diagram for FBRenderOptions:

Public Member Functions

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

Constructor & Destructor Documentation

◆ FBRenderOptions()

FBRenderOptions ( HKRenderOptions  pOptions)

Member Function Documentation

◆ GetIDBufferPickingAlphaThreshold()

float GetIDBufferPickingAlphaThreshold ( )

Get IDBuffer Picking Alpha threshold.

Returns
ID Buffer picking alpha threshold value.

◆ GetRenderFrameId()

int GetRenderFrameId ( )

Get Render Frame ID.

Returns
This return a new ID each time a new frame is drawn.

◆ GetRenderingCamera()

FBCamera GetRenderingCamera ( )

Get the rendering camera.

◆ GetViewerOptions()

FBViewingOptions GetViewerOptions ( )

◆ IsIDBufferRendering()

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.

◆ IsOfflineRendering()

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.