Share via


DebugRenderingSettings.CustomString Property

Definition

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.

public:
 property System::String ^ CustomString { System::String ^ get(); void set(System::String ^ value); };
public string CustomString { get; set; }
member this.CustomString : string with get, set
Public Property CustomString As String

Property Value

Applies to