xrGetVisibilityMaskKHR - Gets visibility mask

Parameter Descriptions

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 @@ extension must be enabled prior to calling getVisibilityMaskKHR

• session must be a valid Session handle
• viewConfigurationType must be a valid ViewConfigurationType value
• visibilityMaskType must be a valid VisibilityMaskTypeKHR value
• visibilityMask must be a pointer to an VisibilityMaskKHR structure

Return Codes

Success

• SUCCESS
• SESSION_LOSS_PENDING

Failure

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

See Also

Session, ViewConfigurationType, VisibilityMaskKHR, VisibilityMaskTypeKHR

XrEventDataVisibilityMaskChangedKHR - Visibility Mask

Valid Usage (Implicit)

• The @@ extension must be enabled prior to using EventDataVisibilityMaskChangedKHR

• type must be TYPE_EVENT_DATA_VISIBILITY_MASK_CHANGED_KHR
• next must be NULL or a valid pointer to the next structure in a structure chain
• session must be a valid Session handle
• viewConfigurationType must be a valid ViewConfigurationType value

See Also

Session, StructureType, ViewConfigurationType

XrVisibilityMaskKHR - Visibility Mask

Member Descriptions

• type is the StructureType of this structure.

• next is NULL or a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR or this extension.
• vertexCapacityInput is the capacity of the vertices array, or 0 to indicate a request to retrieve the required capacity.
• vertexCountOutput is filled in by the runtime with the count of vertices written or the required capacity in the case that vertexCapacityInput or indexCapacityInput is 0.
• vertices is an array of vertices filled in by the runtime that specifies mask coordinates in the z=-1 plane of the rendered view—​i.e., one meter in front of the view. When rendering the mask for use in a projection layer, these vertices must be transformed by the application’s projection matrix used for the respective CompositionLayerProjectionView.

Description

• indexCapacityInput is the capacity of the indices array, or 0 to indicate a request to retrieve the required capacity.

• indexCountOutput is filled in by the runtime with the count of indices written or the required capacity in the case that vertexCapacityInput or indexCapacityInput is 0.
• indices is an array of indices filled in by the runtime, specifying the indices of the mask geometry in the vertices array.

Valid Usage (Implicit)

• The @@ extension must be enabled prior to using VisibilityMaskKHR

• type must be TYPE_VISIBILITY_MASK_KHR
• next must be NULL or a valid pointer to the next structure in a structure chain
• If vertexCapacityInput is not 0, vertices must be a pointer to an array of vertexCapacityInput Vector2f structures
• If indexCapacityInput is not 0, indices must be a pointer to an array of indexCapacityInput uint32_t values

See Also

StructureType, Vector2f, getVisibilityMaskKHR

XrVisibilityMaskTypeKHR - Visibility Mask Type

Enumerant Descriptions

See Also

getVisibilityMaskKHR