SpatialSurfaceMeshOptions SpatialSurfaceMeshOptions SpatialSurfaceMeshOptions SpatialSurfaceMeshOptions Class

Definition

Provides options to customize the SpatialSurfaceMesh objects you get back from SpatialSurfaceInfo.TryComputeLatestMeshAsync.

public : sealed class SpatialSurfaceMeshOptions : ISpatialSurfaceMeshOptionspublic sealed class SpatialSurfaceMeshOptions : ISpatialSurfaceMeshOptionsPublic NotInheritable Class SpatialSurfaceMeshOptions Implements ISpatialSurfaceMeshOptions// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10586.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v2)

Constructors

SpatialSurfaceMeshOptions() SpatialSurfaceMeshOptions() SpatialSurfaceMeshOptions() SpatialSurfaceMeshOptions()

Initializes a new instance of the SpatialSurfaceMeshOptions class.

public : SpatialSurfaceMeshOptions()public SpatialSurfaceMeshOptions()Public Sub New()// You can use this method in JavaScript.

Properties

IncludeVertexNormals IncludeVertexNormals IncludeVertexNormals IncludeVertexNormals

Gets or sets whether to compute a normal buffer.

public : PlatForm::Boolean IncludeVertexNormals { get; set; }public bool IncludeVertexNormals { get; set; }Public ReadWrite Property IncludeVertexNormals As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

Whether to compute normals.

Remarks

SpatialSurfaceMesh.VertexNormals will only be non-null if IncludeVertexNormals is set to true.

SupportedTriangleIndexFormats SupportedTriangleIndexFormats SupportedTriangleIndexFormats SupportedTriangleIndexFormats

Gets a list of the triangle index formats that the system can generate an index buffer in.

public : static IVectorView<DirectXPixelFormat> SupportedTriangleIndexFormats { get; }public static IReadOnlyList<DirectXPixelFormat> SupportedTriangleIndexFormats { get; }Public Static ReadOnly Property SupportedTriangleIndexFormats As IReadOnlyList<DirectXPixelFormat>// You can use this property in JavaScript.
Value
IVectorView<DirectXPixelFormat> IReadOnlyList<DirectXPixelFormat> IReadOnlyList<DirectXPixelFormat> IReadOnlyList<DirectXPixelFormat>

The supported index buffer formats.

Remarks

Supply a value from this list to the TriangleIndexFormat property when calling SpatialSurfaceInfo.TryComputeLatestMeshAsync to request index buffers in that format.

SupportedVertexNormalFormats SupportedVertexNormalFormats SupportedVertexNormalFormats SupportedVertexNormalFormats

Gets a list of the vertex normal formats that the system can generate a normal buffer in.

public : static IVectorView<DirectXPixelFormat> SupportedVertexNormalFormats { get; }public static IReadOnlyList<DirectXPixelFormat> SupportedVertexNormalFormats { get; }Public Static ReadOnly Property SupportedVertexNormalFormats As IReadOnlyList<DirectXPixelFormat>// You can use this property in JavaScript.
Value
IVectorView<DirectXPixelFormat> IReadOnlyList<DirectXPixelFormat> IReadOnlyList<DirectXPixelFormat> IReadOnlyList<DirectXPixelFormat>

The supported normal buffer formats.

Remarks

Supply a value from this list to the VertexNormalFormat property when calling SpatialSurfaceInfo.TryComputeLatestMeshAsync to request normal buffers in that format.

SupportedVertexPositionFormats SupportedVertexPositionFormats SupportedVertexPositionFormats SupportedVertexPositionFormats

Gets a list of the vertex position formats that the system can generate a vertex buffer in.

public : static IVectorView<DirectXPixelFormat> SupportedVertexPositionFormats { get; }public static IReadOnlyList<DirectXPixelFormat> SupportedVertexPositionFormats { get; }Public Static ReadOnly Property SupportedVertexPositionFormats As IReadOnlyList<DirectXPixelFormat>// You can use this property in JavaScript.
Value
IVectorView<DirectXPixelFormat> IReadOnlyList<DirectXPixelFormat> IReadOnlyList<DirectXPixelFormat> IReadOnlyList<DirectXPixelFormat>

The supported vertex buffer formats.

Remarks

Supply a value from this list to the VertexPositionFormat property when calling SpatialSurfaceInfo.TryComputeLatestMeshAsync to request vertex buffers in that format.

TriangleIndexFormat TriangleIndexFormat TriangleIndexFormat TriangleIndexFormat

Gets or sets the element format for generated index buffers.

public : DirectXPixelFormat TriangleIndexFormat { get; set; }public DirectXPixelFormat TriangleIndexFormat { get; set; }Public ReadWrite Property TriangleIndexFormat As DirectXPixelFormat// You can use this property in JavaScript.

VertexNormalFormat VertexNormalFormat VertexNormalFormat VertexNormalFormat

Gets or sets the element format for generated normal buffers.

public : DirectXPixelFormat VertexNormalFormat { get; set; }public DirectXPixelFormat VertexNormalFormat { get; set; }Public ReadWrite Property VertexNormalFormat As DirectXPixelFormat// You can use this property in JavaScript.

Remarks

Note that normal buffers will only be generated if you set IncludeVertexNormals to true.

VertexPositionFormat VertexPositionFormat VertexPositionFormat VertexPositionFormat

Gets or sets the element format for generated vertex buffers.

public : DirectXPixelFormat VertexPositionFormat { get; set; }public DirectXPixelFormat VertexPositionFormat { get; set; }Public ReadWrite Property VertexPositionFormat As DirectXPixelFormat// You can use this property in JavaScript.