RenderPickerSurfacePickSurface Method

Picks the surface at a given pixel position.

Namespace: Lumiscaphe.Workshop.Interop
Assembly: Lumiscaphe.Workshop.Interop (in Lumiscaphe.Workshop.Interop.dll) Version: 21.1.16.0

Syntax

C++

Copy

public static RenderPickerPickSurface PickSurface(
	RenderSceneManager manager,
	SceneGuid scene,
	RenderSnapshot snapshot,
	RenderRendererParameters rendererParameters,
	RenderPosition position,
	RenderPickerBuffer pickBuffer
)

public:
static RenderPickerPickSurface^ PickSurface(
	RenderSceneManager^ manager, 
	SceneGuid scene, 
	RenderSnapshot snapshot, 
	RenderRendererParameters^ rendererParameters, 
	RenderPosition position, 
	RenderPickerBuffer^ pickBuffer
)

Parameters

manager: Type: Lumiscaphe.Workshop.InteropRenderSceneManager
The scene manager.
scene: Type: Lumiscaphe.Workshop.InteropSceneGuid
The scene identifier.
snapshot: Type: Lumiscaphe.Workshop.InteropRenderSnapshot
The rendering snapshot.
rendererParameters: Type: Lumiscaphe.Workshop.InteropRenderRendererParameters
The renderer parameters.
position: Type: Lumiscaphe.Workshop.InteropRenderPosition
The pixel position.
pickBuffer: Type: Lumiscaphe.Workshop.InteropRenderPickerBuffer
The pick buffer.

Return Value

Type: RenderPickerPickSurface
The picked surface if a surface exists under position; otherwise, null.

Exceptions

Exception	Condition
ObjectNullException	manager == null, rendererParameters == null, pickBuffer == null
ObjectDestroyedException	RenderSceneManager::IsDestroyed == true, RenderPickerBuffer::IsDestroyed == true
ObjectDisposedException	RenderRendererParameters::IsDisposed == true

Version Information

Lumiscaphe Workshop SDK

Supported in: 7.0 release 1

Reference

RenderPickerSurface Class

Lumiscaphe.Workshop.Interop Namespace

RenderPickerSurfaceAddLanguageSpecificTextSet("LSTA2F2CC31_0?cpp=::|nu=.");PickSurface Method

Parameters

Return Value

Lumiscaphe Workshop SDK

Reference

RenderPickerSurfacePickSurface Method