RenderHeadUpDisplay Class

The RenderHeadUpDisplay class is a compositer hook used to display 2D elements over the final image.
This object must be passed to the RenderCompositer::Render method.

Inheritance Hierarchy

SystemObject
Lumiscaphe.Workshop.InteropRenderHeadUpDisplay

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

Syntax

C++

Copy

public class RenderHeadUpDisplay : IRenderCompositerHook, 
	IDisposable

public ref class RenderHeadUpDisplay : IRenderCompositerHook, 
	IDisposable

The RenderHeadUpDisplay type exposes the following members.

Constructors

	Name	Description
	RenderHeadUpDisplay	Initializes a new instance of the RenderHeadUpDisplay class.

Top

Properties

	Name	Description
	Elements	Gets or sets the RenderHeadUpDisplay elements. It represents the list of 2D objects to display over the final image.
	IsDisposed	Gets a value indicating whether this instance is disposed.
	Visible	Gets or sets a value indicating whether this RenderHeadUpDisplay is visible.

Top

Methods

	Name	Description
	Dispose	Releases all resources used by the RenderHeadUpDisplay
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Render	Does the rendering of all elements contained in the head up display.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Version Information

Lumiscaphe Workshop SDK

Supported in: 7.0 release 1

Reference

Lumiscaphe.Workshop.Interop Namespace