Package org.lwjgl.openxr

Class KHRVisibilityMask

java.lang.Object

org.lwjgl.openxr.KHRVisibilityMask

public class KHRVisibilityMask
extends Object

The XR_KHR_visibility_mask extension.

This extension support the providing of a per-view drawing mask for applications. The primary purpose of this is to enable performance improvements that result from avoiding drawing on areas that are not visible to the user. A common occurrence in head-mounted VR hardware is that the optical system’s frustum does not intersect precisely with the rectangular display it is viewing. As a result, it may be that there are parts of the display that are not visible to the user, such as the corners of the display. In such cases it would be unnecessary for the application to draw into those parts.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XR_KHR_VISIBILITY_MASK_EXTENSION_NAME	The extension name.
static final int	XR_KHR_visibility_mask_SPEC_VERSION	The extension specification version.
static final int	XR_TYPE_EVENT_DATA_VISIBILITY_MASK_CHANGED_KHR	Extends XrStructureType.
static final int	XR_TYPE_VISIBILITY_MASK_KHR	Extends XrStructureType.
static final int	XR_VISIBILITY_MASK_TYPE_HIDDEN_TRIANGLE_MESH_KHR	XrVisibilityMaskTypeKHR - Visibility Mask Type
static final int	XR_VISIBILITY_MASK_TYPE_LINE_LOOP_KHR	XrVisibilityMaskTypeKHR - Visibility Mask Type
static final int	XR_VISIBILITY_MASK_TYPE_VISIBLE_TRIANGLE_MESH_KHR	XrVisibilityMaskTypeKHR - Visibility Mask Type

Method Summary

Modifier and Type	Method	Description
static int	nxrGetVisibilityMaskKHR(XrSession session, int viewConfigurationType, int viewIndex, int visibilityMaskType, long visibilityMask)	Unsafe version of: GetVisibilityMaskKHR
static int	xrGetVisibilityMaskKHR(XrSession session, int viewConfigurationType, int viewIndex, int visibilityMaskType, XrVisibilityMaskKHR visibilityMask)	Gets visibility mask.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

XR_KHR_visibility_mask_SPEC_VERSION

public static final int XR_KHR_visibility_mask_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_KHR_VISIBILITY_MASK_EXTENSION_NAME

public static final String XR_KHR_VISIBILITY_MASK_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_TYPE_VISIBILITY_MASK_KHR

public static final int XR_TYPE_VISIBILITY_MASK_KHR

Extends XrStructureType.

Enum values:

• TYPE_VISIBILITY_MASK_KHR
• TYPE_EVENT_DATA_VISIBILITY_MASK_CHANGED_KHR

See Also:

• Constant Field Values

XR_TYPE_EVENT_DATA_VISIBILITY_MASK_CHANGED_KHR

public static final int XR_TYPE_EVENT_DATA_VISIBILITY_MASK_CHANGED_KHR

Extends XrStructureType.

Enum values:

• TYPE_VISIBILITY_MASK_KHR
• TYPE_EVENT_DATA_VISIBILITY_MASK_CHANGED_KHR

See Also:

• Constant Field Values

XR_VISIBILITY_MASK_TYPE_HIDDEN_TRIANGLE_MESH_KHR

public static final int XR_VISIBILITY_MASK_TYPE_HIDDEN_TRIANGLE_MESH_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

See Also:

• Constant Field Values

XR_VISIBILITY_MASK_TYPE_VISIBLE_TRIANGLE_MESH_KHR

public static final int XR_VISIBILITY_MASK_TYPE_VISIBLE_TRIANGLE_MESH_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

See Also:

• Constant Field Values

XR_VISIBILITY_MASK_TYPE_LINE_LOOP_KHR

public static final int XR_VISIBILITY_MASK_TYPE_LINE_LOOP_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

See Also:

• Constant Field Values

Method Details

nxrGetVisibilityMaskKHR

public static int nxrGetVisibilityMaskKHR(XrSession session,
 int viewConfigurationType,
 int viewIndex,
 int visibilityMaskType,
 long visibilityMask)

Unsafe version of: GetVisibilityMaskKHR

xrGetVisibilityMaskKHR

public static int xrGetVisibilityMaskKHR(XrSession session,
 int viewConfigurationType,
 int viewIndex,
 int visibilityMaskType,
 XrVisibilityMaskKHR visibilityMask)

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 XrVisibilityMaskKHR::vertexCapacityInput or XrVisibilityMaskKHR::indexCapacityInput is 0, the runtime must respond as if both fields were set to 0, returning the vertex count and index count through XrVisibilityMaskKHR::vertexCountOutput or XrVisibilityMaskKHR::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 - an XrSession handle previously created with CreateSession.

viewConfigurationType - the view configuration from which to retrieve mask information.

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

visibilityMaskType - the type of visibility mask requested.

visibilityMask - an input/output struct which specifies the view mask.