Class DebugRenderingSettings
Options for debug rendering features
class Microsoft::Azure::RemoteRendering::DebugRenderingSettings final
Properties
CustomString
User controlled string that is rendered into the frame when the DebugRenderingSettings.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.
auto GetCustomString(std::string & out) const noexcept -> void;
auto SetCustomString(std::string const& value) noexcept -> Microsoft::Azure::RemoteRendering::Status;
RenderCustomString
Controls whether the string passed as DebugRenderingSettings.CustomString is rendered into the frame.
auto GetRenderCustomString() const noexcept -> bool;
auto SetRenderCustomString(bool value) noexcept -> Microsoft::Azure::RemoteRendering::Status;
RenderFrameCount
Controls the server-side overlay to render a frame counter.
auto GetRenderFrameCount() const noexcept -> bool;
auto SetRenderFrameCount(bool value) noexcept -> Microsoft::Azure::RemoteRendering::Status;
RenderPrimitiveCount
Controls the server-side overlay to render the primitive count.
auto GetRenderPrimitiveCount() const noexcept -> bool;
auto SetRenderPrimitiveCount(bool value) noexcept -> Microsoft::Azure::RemoteRendering::Status;
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.
auto GetRenderTimeStamp() const noexcept -> bool;
auto SetRenderTimeStamp(bool value) noexcept -> Microsoft::Azure::RemoteRendering::Status;
RenderWireframe
Controls whether geometry should be rendered as wireframe.
auto GetRenderWireframe() const noexcept -> bool;
auto SetRenderWireframe(bool value) noexcept -> Microsoft::Azure::RemoteRendering::Status;
Valid
Whether this object is still valid.
An object is invalid if it has been destroyed or if the connection has been lost. It is an error to call any other function on an invalid object.
auto GetValid() const noexcept -> bool;