IDirect3DRMFrame2::SetBoxEnable

Enables or disables bounding box testing for this Direct3DRMFrame2 object. Bounding box testing cannot be enabled unless a valid bounding box has already been set on the frame.

HRESULT SetBoxEnable(
BOOL bEnableFlag
);

Parameters

bEnableFlag

TRUE to enable a bounding box. FALSE if a bounding box is not enabled. Default is FALSE.

Return Values

Returns D3DRM_OK if successful, or an error otherwise. For a list of possible return codes, see Direct3D Retained-Mode Return Values.

Remarks

For a bounding box to be enabled, this method must be called to set the enable flag to TRUE. By default, the box enable flag is FALSE.

Bounding box testing is performed as follows: at render time the bounding box is transformed into model space and checked for intersection with the viewing frustum. If all of the box is outside of the viewing frustum, none of the visuals in the frame or in any child frames are rendered. Otherwise, rendering continues as normal.

Enabling bounding box testing with a box of {0,0,0,0} completely prevents a frame from being rendered.

See Also

IDirect3DRMFrame2::GetBoxEnable, IDirect3DRMFrame2::GetBox, IDirect3DRMFrame2::SetBox