public Class KHRVisibilityMask

The extension name.

The extension specification version.

Extends XrStructureType.

Enum values:

• TYPE_VISIBILITY_MASK_KHR
• TYPE_EVENT_DATA_VISIBILITY_MASK_CHANGED_KHR

Extends XrStructureType.

Enum values:

• TYPE_VISIBILITY_MASK_KHR
• TYPE_EVENT_DATA_VISIBILITY_MASK_CHANGED_KHR

XrVisibilityMaskTypeKHR - Visibility Mask Type

Enumerant Descriptions

• VISIBILITY_MASK_TYPE_HIDDEN_TRIANGLE_MESH_KHR refers to a two dimensional triangle mesh on the view surface which should not be drawn to by the application. XrVisibilityMaskKHR refers to a set of triangles identified by vertices and vertex indices. The index count will thus be a multiple of three. The triangle vertices will be returned in counter-clockwise order as viewed from the user perspective.
• VISIBILITY_MASK_TYPE_VISIBLE_TRIANGLE_MESH_KHR refers to a two dimensional triangle mesh on the view surface which should be drawn to by the application. XrVisibilityMaskKHR refers to a set of triangles identified by vertices and vertex indices. The index count will thus be a multiple of three. The triangle vertices will be returned in counter-clockwise order as viewed from the user perspective.
• VISIBILITY_MASK_TYPE_LINE_LOOP_KHR refers to a single multi-segmented line loop on the view surface which encompasses the view area which should be drawn by the application. It is the border that exists between the visible and hidden meshes identified by VISIBILITY_MASK_TYPE_HIDDEN_TRIANGLE_MESH_KHR and VISIBILITY_MASK_TYPE_VISIBLE_TRIANGLE_MESH_KHR. The line is counter-clockwise, contiguous, and non-self crossing, with the last point implicitly connecting to the first point. There is one vertex per point, the index count will equal the vertex count, and the indices will refer to the vertices.

See Also

GetVisibilityMaskKHR

XrVisibilityMaskTypeKHR - Visibility Mask Type

Enumerant Descriptions

• VISIBILITY_MASK_TYPE_HIDDEN_TRIANGLE_MESH_KHR refers to a two dimensional triangle mesh on the view surface which should not be drawn to by the application. XrVisibilityMaskKHR refers to a set of triangles identified by vertices and vertex indices. The index count will thus be a multiple of three. The triangle vertices will be returned in counter-clockwise order as viewed from the user perspective.
• VISIBILITY_MASK_TYPE_VISIBLE_TRIANGLE_MESH_KHR refers to a two dimensional triangle mesh on the view surface which should be drawn to by the application. XrVisibilityMaskKHR refers to a set of triangles identified by vertices and vertex indices. The index count will thus be a multiple of three. The triangle vertices will be returned in counter-clockwise order as viewed from the user perspective.
• VISIBILITY_MASK_TYPE_LINE_LOOP_KHR refers to a single multi-segmented line loop on the view surface which encompasses the view area which should be drawn by the application. It is the border that exists between the visible and hidden meshes identified by VISIBILITY_MASK_TYPE_HIDDEN_TRIANGLE_MESH_KHR and VISIBILITY_MASK_TYPE_VISIBLE_TRIANGLE_MESH_KHR. The line is counter-clockwise, contiguous, and non-self crossing, with the last point implicitly connecting to the first point. There is one vertex per point, the index count will equal the vertex count, and the indices will refer to the vertices.

See Also

GetVisibilityMaskKHR

XrVisibilityMaskTypeKHR - Visibility Mask Type

Enumerant Descriptions

• VISIBILITY_MASK_TYPE_HIDDEN_TRIANGLE_MESH_KHR refers to a two dimensional triangle mesh on the view surface which should not be drawn to by the application. XrVisibilityMaskKHR refers to a set of triangles identified by vertices and vertex indices. The index count will thus be a multiple of three. The triangle vertices will be returned in counter-clockwise order as viewed from the user perspective.
• VISIBILITY_MASK_TYPE_VISIBLE_TRIANGLE_MESH_KHR refers to a two dimensional triangle mesh on the view surface which should be drawn to by the application. XrVisibilityMaskKHR refers to a set of triangles identified by vertices and vertex indices. The index count will thus be a multiple of three. The triangle vertices will be returned in counter-clockwise order as viewed from the user perspective.
• VISIBILITY_MASK_TYPE_LINE_LOOP_KHR refers to a single multi-segmented line loop on the view surface which encompasses the view area which should be drawn by the application. It is the border that exists between the visible and hidden meshes identified by VISIBILITY_MASK_TYPE_HIDDEN_TRIANGLE_MESH_KHR and VISIBILITY_MASK_TYPE_VISIBLE_TRIANGLE_MESH_KHR. The line is counter-clockwise, contiguous, and non-self crossing, with the last point implicitly connecting to the first point. There is one vertex per point, the index count will equal the vertex count, and the indices will refer to the vertices.

See Also

GetVisibilityMaskKHR

Unsafe version of: GetVisibilityMaskKHR

Gets visibility mask.

C Specification

The GetVisibilityMaskKHR function is defined as:

XrResult xrGetVisibilityMaskKHR(
    XrSession                                   session,
    XrViewConfigurationType                     viewConfigurationType,
    uint32_t                                    viewIndex,
    XrVisibilityMaskTypeKHR                     visibilityMaskType,
    XrVisibilityMaskKHR*                        visibilityMask);

Description

GetVisibilityMaskKHR retrieves the view mask for a given view. This function follows the two-call idiom for filling multiple buffers in a struct. Specifically, if either vertexCapacityInput or indexCapacityInput is 0, the runtime must respond as if both fields were set to 0, returning the vertex count and index count through vertexCountOutput or indexCountOutput respectively. If a view mask for the specified view isn’t available, the returned vertex and index counts must be 0.

Valid Usage (Implicit)

• The XR_KHR_visibility_mask extension must be enabled prior to calling GetVisibilityMaskKHR
• session must be a valid XrSession handle
• viewConfigurationType must be a valid XrViewConfigurationType value
• visibilityMaskType must be a valid XrVisibilityMaskTypeKHR value
• visibilityMask must be a pointer to an XrVisibilityMaskKHR structure

Return Codes

On success, this command returns

• SUCCESS
• SESSION_LOSS_PENDING

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_VALIDATION_FAILURE
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_SIZE_INSUFFICIENT
• ERROR_VIEW_CONFIGURATION_TYPE_UNSUPPORTED

See Also

XrVisibilityMaskKHR

Parameters

session:XrSession

an XrSession handle previously created with CreateSession.

viewConfigurationType:int

the view configuration from which to retrieve mask information.

viewIndex:int

the individual view within the view configuration from which to retrieve mask information.

visibilityMaskType:int

the type of visibility mask requested.

visibilityMask:XrVisibilityMaskKHR

an input/output struct which specifies the view mask.

Annotations

@NativeType:XrResult