Microsoft.Azure.RemoteRendering Namespace

Classes

AssetConversionResult

Deprecated, do not use

AssetConversionStatusResult

Deprecated, use ConversionPropertiesResult instead.

CameraSettings

Camera settings.

ColorMaterial

A material that doesn't get any lighting applied.

ComponentBase

Base class for all components.

ConversionPropertiesArrayResult

Result object that is returned by GetCurrentConversionsAsync(). Success state and additional error context can be retrieved via base class SessionContextResult. In case of success, the Conversions property holds a valid array of ConversionProperties instances.

ConversionPropertiesResult

Result object that is returned by GetConversionPropertiesAsync(String). Success state and additional error context can be retrieved via base class SessionContextResult. In case of success, the Properties property holds a valid instance of ConversionProperties.

CreateRenderingSessionResult

Result object that is returned by OpenRenderingSessionAsync(String) and CreateNewRenderingSessionAsync(RenderingSessionCreationOptions). Success state and additional error context can be retrieved via base class SessionContextResult. In case of success, the Session property holds a valid RenderingSession reference.

CutPlaneComponent

Cut planes are used to cut away parts of meshes to be able to peek inside.

DebugRenderingSettings

Options for debug rendering features

DirectionalLightComponent

A light source that emits light globally into a fixed direction.

DisableInSimulationAttribute

Disable the corresponding UI field when in Simulation mode.

EnableInSimulationAttribute

Disable the corresponding UI field when not in Simulation mode.

Entity

An entity represents an object in space.

GraphicsBinding

Base class for graphics bindings.

GraphicsBindingOpenXrD3d11

D3D11 binding for OpenXR.

GraphicsBindingOpenXrVulkan

Vulkan binding for OpenXR.

GraphicsBindingSimD3d11

Graphics API binding for local simulation.

GraphicsBindingWmrD3d11

D3D11 binding for Windows Mixed Reality.

HierarchicalStateOverrideComponent

Controls the visualization of sub-hierarchies of entities.

LightComponentBase

Base class for all light components.

LoadModelResult

Result data for a load model request.

Material

Materials are shared resources used to describe the rendering properties of a Mesh.

Mesh

Meshes contain geometry data and Material references for rendering.

MeshComponent

Renders a mesh at the position of the Entity.

NativeLibraryExtensions
ObjectBase

Base class for entities and components.

ObjectMetadata

A collection of metadata values for an object.

ObjectMetadataEntry

A single metadata entry for an object.

OutlineSettings

Global settings for outline rendering.

PbrMaterial

A material for Physically Based Rendering.

PointCloudSettings

Settings for point cloud rendering (experimental).

PointLightComponent

A light source that emits light uniformly into all directions.

RayCastQueryResult

Result object that is returned by RayCastQueryAsync(RayCast). This class holds a (potentially empty) array of.ray cast hits after an asynchronous ray cast call.

RemoteManagerStatic
RemoteRenderingClient

RemoteRenderingClient is an authorized connection to the Azure APIs for Remote Rendering.

RenderingConnection

Main entry point for Remote Rendering specific actions. Can be accessed via RenderingSession.Connection, after a successful connection.

RenderingSession

Each rendering session is running on a dedicated server, providing the Azure Remote Rendering functionality.

RenderingSessionPropertiesArrayResult

Result object that is returned by GetCurrentRenderingSessionsAsync(). Success state and additional error context can be retrieved via base class SessionContextResult. In case of success, the SessionProperties property holds a valid array of RenderingSessionProperties instances.

RenderingSessionPropertiesResult

Result object that is returned by GetPropertiesAsync(). Success state and additional error context can be retrieved via base class SessionContextResult. In case of success, the SessionProperties property holds a valid instance of RenderingSessionProperties.

ResourceBase

Base class for all resources.

RRException

Base class for all Remote Rendering API exceptions.

RRSessionException

Base class for all remote rendering session exceptions.

ServiceStatistics

This class provides statistics about the video stream from the service.

The instance needs to be updated every frame to produce averages.

SessionContextResult

Base result class for all session related async queries. This result has an ErrorCode property to test whether the query was successful. In case of error, additional information can be gathered through the Context object. See SessionGeneralContext

ShellRenderingSettings

Global settings for objects rendered using the hierarchical override shell effect.

SingleSidedSettings

Settings for single-sided geometry rendering.

SkyReflectionSettings

Settings for the global sky reflections.

SpatialQueryResult

The result of a successful spatial query

SpotLightComponent

A light source that emits light within a directed cone.

StageSpaceSettings

Options for changing the stage-space origin.

Texture

Textures represent images that can be applied to geometry.

TokenRequiredEventArgs

Informs the application that the service requires an updated access token or authentication token.

ToolingConstants
ValidationUtils

Constants for remote rendering.

ZFightingMitigationSettings

Settings for z-fighting mitigation.

Structs

AssetConversionInputOptions

Input parameters for specifying an asset to convert.

AssetConversionOptions

Parameters for specifying the output location of a converted asset.

AssetConversionOutputOptions

Parameters for specifying the output location of a converted asset.

Bounds

An axis-aligned bounding box (AABB). It is defined through two corners in world-space that span the box.

CameraFov

A generic, possibly off-center definition of a camera's field of view.

Color4

4-component color (red, green, blue, alpha) with single precision.

Color4Ub

4 component color (red, green, blue, alpha) based on 8 bit components [0..255].

ConversionProperties

Properties of an asset conversion.

Double3

3-component vector with double precision.

Float2

2-component vector with single precision.

Float3

3-component vector with single precision.

Float4

4-component vector with single precision.

FrameStatistics

Frame statistics to do client-side performance assessment. See GetLastFrameStatistics(FrameStatistics).

LoadFromBlobOptions

Parameters for loading data from Azure blob storage.

LoadModelFromSasOptions

Parameters for loading a model using a URI.

LoadModelOptions

Parameters for loading a model from Azure blob storage.

LoadTextureFromSasOptions

Parameters for loading a texture using a URI.

LoadTextureOptions

Parameters for loading a texture.

Matrix4x4

4x4 matrix based on single precision components.

OrientedBox

An oriented bounding box (OBB).

PerformanceAssessment

Performance assessment of Remote Rendering statistics. See QueryServerPerformanceAssessmentAsync().

PerformanceInformation

Describes a single performance assessment value. See PerformanceAssessment.

Plane

A plane in 3d space described by 4 components A, B, C and D. In ARR, planes are defined in standard normal form, which means a 3d position (x,y,z) is on the plane when it satisfies Ax + By + C*z + D = 0.

Quaternion

Single precision quaternion to describe an object rotation.

RayCast

Parameters for doing a raycast.

RayCastHit

Contains information about a single raycast hit.

RemoteRenderingInitialization

Options for Remote Rendering runtime initialization.

RendererInitOptions

Parameters for connecting to the runtime of an RenderingSession.

RenderingSessionCreationOptions

Parameters for creating a rendering session.

RenderingSessionCreationOptionsUnsafe

Internal struct.

RenderingSessionProperties

Properties of a rendering session.

RenderingSessionUpdateOptions

Parameters for updating a rendering session.

ResourceStateResult_Experimental

Result structure returned by GetResourceStateAsync_Experimental().

ServiceStatistics.AggregatedStatistics
SessionConfiguration

Account information and domain to associate an RemoteRenderingClient instance with.

SessionGeneralContext

Extended return value information for RenderingSession and RemoteRenderingClient async calls.

SimulationUpdateParameters

When GraphicsBindingSimD3d11 is used, this must be filled out and passed to Update(SimulationUpdateParameters, SimulationUpdateResult) once per frame.

SimulationUpdateResult

When GraphicsBindingSimD3d11 is used, objects of this struct will contain the result after successfully calling Update(SimulationUpdateParameters, SimulationUpdateResult).

SpatialQuery

Input parameter for performing a spatial query with an AABB. All mesh components that overlap with this box will be returned.

SpatialQueryAabb

Input parameters for performing a spatial query with an axis-aligned bounding box (AABB). Mesh components that overlap with it will be returned.

SpatialQueryObb

Input parameters for performing a spatial query with an oriented bounding box. Mesh components that overlap with it will be returned.

SpatialQuerySphere

Input parameters for performing a spatial query with a sphere. Mesh components that overlap with it will be returned.

Sphere

It's a sphere.

StereoCameraFov

This struct holds field of views for the left and right camera view in stereo rendering.

StereoMatrix4x4

This struct holds matrices for the left and right camera view in stereo rendering.

Transform

Describes a transform in 3d space (local space or world space), which consists of position, rotation and scaling.

VulkanRenderParameters

When GraphicsBindingOpenXrVulkan is used, this must be filled out and passed to PrepareRender(VulkanRenderParameters) and BlitRemoteFrame(VulkanRenderParameters) once per frame.

Enums

Axis

Coordinate system axis definitions.

ColorMaterialFeatures

Flags specific to the ColorMaterial.

ColorTransparencyMode

Defines whether the ColorMaterial is transparent and how it blends with the background.

ConnectionStatus

Status of the connection to the server.

ConnectionType

The type of connection to use.

ConversionSessionStatus

Deprecated, use ConversionStatus instead.

ConversionStatus

The status of an asset conversion.

DepthConvention

The screen space floating point z convention used for rendering

Entity.VisitorResult

Result code used by the VisitEntityDelegate to signal if the visitor should continue to traverse the scenegraph or not.

FocusPointResult

The state of the remote focus point in the current frame.

GraphicsApiType

Supported graphics APIs.

HierarchicalEnableState

Enum that describes the three enabled states in a hierarchical context. HierarchicalEnableState is used in conjunction with HierarchicalStates

HierarchicalStates

Render properties that can be overridden by the HierarchicalStateOverrideComponent

HitCollectionPolicy

Determines which hits a raycast query returns.

LogLevel

Logging severity levels.

MaterialType

Supported material types.

MetadataValueType

Specifies the type of a metadata value.

ObjectType

The different types of objects used by ARR.

PbrMaterialFeatures

Flags specific to the PbrMaterial.

PbrVertexAlphaMode

Defines how the alpha portion of a mesh's vertex color contributes to the final color.

PerformanceRating

Specifies broad categories for assessing the meaning of a performance measurement.

PoseMode

The pose mode used for rendering.

RayHitType

Classifies the hit type of an individual raycast hit result.

RenderingSessionStatus

Status of a rendering session.

RenderingSessionVmSize

Size of the server used for the rendering session.

ResourceDataSourceState_Experimental

Enumeration that describes possible states of a resource, with regards to the resource's connection to its data source.

Result

Generic result type used by the Remote Rendering API.

ServiceRenderMode

The possible modes for the server side rendering.

SingleSidedMode

Options for rendering single-sided geometry.

StringComparison

Enum that provides a set of pre-defined string comparison methods.

TextureCoordinateGenerationMode

Defines the method the Uv texture coordinates are generated for material texture sampling.

TextureType

The supported texture types.

Delegates

ConnectionStatusChangedEventHandler

Delegate for receiving connection status updates.

Entity.EntitySearchDelegate

Delegate used to search an entity hierarchy for an entity inclusive of its children.

Entity.VisitEntityDelegate

Delegate used to visit an entity hierarchy inclusive of its children.

LogEventHandler

Delegate for receiving log messages.

RemoteManagerStatic.ExceptionLoggedDelegate
RemoteManagerStatic.ShutdownDelegate
RenderingConnectionUpdatedEventHandler

Delegate for receiving notification when an update tick has completed on a RenderingConnection.

TokenRequiredEventHandler

Informs the application that a remote rendering client requires an updated access token or authentication token.