DebugRenderingSettings Class

Definition

Namespace:

Microsoft.Azure.RemoteRendering

Assembly:

RemoteRenderingClientCS.dll

Options for debug rendering features

public ref class DebugRenderingSettings

public class DebugRenderingSettings

type DebugRenderingSettings = class

Public Class DebugRenderingSettings

Inheritance

Object

DebugRenderingSettings

Properties

CustomString	User controlled string that is rendered into the frame when the RenderCustomString flag is enabled. This value can be used for instance when debugging the entire latency from setting a value through the API until it's shown in remote content in the client app. Specifically, this could encode a counter that is incremented every frame and that is also rendered as local content. Then the discrepancy between these two numbers corresponds to the number of frames latency 'pose to display'. When trying to set a string longer than 64 characters, a "Status.StringTooLong" error occurs. Furthermore, the string must consist only of ASCII characters, otherwise a "Status.InvalidParam" error occurs.
RenderCustomString	Controls whether the string passed as CustomString is rendered into the frame.
RenderFrameCount	Controls the server-side overlay to render a frame counter.
RenderPrimitiveCount	Controls the server-side overlay to render the primitive count.
RenderTimeStamp	Controls whether a time stamp should be put into the rendered image. If enabled, the renderer puts a timestamp into the image which corresponds to the fractional number of seconds elapsed since server start.
RenderWireframe	Controls whether geometry should be rendered as wireframe.
Valid	Whether this object is still valid.

See also

• DebugRenderingSettings
• Debug Rendering