Package org.lwjgl.openxr

Class FBTriangleMesh

java.lang.Object

org.lwjgl.openxr.FBTriangleMesh

public class FBTriangleMesh
extends Object

The XR_FB_triangle_mesh extension.

Meshes may be useful in XR applications when representing parts of the environment. In particular, application may provide the surfaces of real-world objects tagged manually to the runtime, or obtain automatically detected environment contents.

This extension allows:

• An application to create a triangle mesh and specify the mesh data.
• An application to update mesh contents if a mesh is mutable.

In order to enable the functionality of this extension, the application must pass the name of the extension into CreateInstance via the XrInstanceCreateInfo::enabledExtensionNames parameter as indicated in the extension section.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XR_FB_TRIANGLE_MESH_EXTENSION_NAME	The extension name.
static final int	XR_FB_triangle_mesh_SPEC_VERSION	The extension specification version.
static final int	XR_OBJECT_TYPE_TRIANGLE_MESH_FB	Extends XrObjectType.
static final int	XR_TRIANGLE_MESH_MUTABLE_BIT_FB	XrTriangleMeshFlagBitsFB - XrTriangleMeshFlagBitsFB
static final int	XR_TYPE_TRIANGLE_MESH_CREATE_INFO_FB	Extends XrStructureType.
static final int	XR_WINDING_ORDER_CCW_FB	XrWindingOrderFB - Triangle winding order
static final int	XR_WINDING_ORDER_CW_FB	XrWindingOrderFB - Triangle winding order
static final int	XR_WINDING_ORDER_UNKNOWN_FB	XrWindingOrderFB - Triangle winding order

Method Summary

Modifier and Type	Method	Description
static int	nxrCreateTriangleMeshFB(XrSession session, long createInfo, long outTriangleMesh)	Unsafe version of: CreateTriangleMeshFB
static int	nxrTriangleMeshBeginVertexBufferUpdateFB(XrTriangleMeshFB mesh, long outVertexCount)	Unsafe version of: TriangleMeshBeginVertexBufferUpdateFB
static int	nxrTriangleMeshGetIndexBufferFB(XrTriangleMeshFB mesh, long outIndexBuffer)	Unsafe version of: TriangleMeshGetIndexBufferFB
static int	nxrTriangleMeshGetVertexBufferFB(XrTriangleMeshFB mesh, long outVertexBuffer)	Unsafe version of: TriangleMeshGetVertexBufferFB
static int	xrCreateTriangleMeshFB(XrSession session, XrTriangleMeshCreateInfoFB createInfo, org.lwjgl.PointerBuffer outTriangleMesh)	Create a triangle mesh.
static int	xrDestroyTriangleMeshFB(XrTriangleMeshFB mesh)	Destroy a triangle mesh.
static int	xrTriangleMeshBeginUpdateFB(XrTriangleMeshFB mesh)	Begin an update of the mesh data.
static int	xrTriangleMeshBeginVertexBufferUpdateFB(XrTriangleMeshFB mesh, IntBuffer outVertexCount)	Begin an update of the vertex data.
static int	xrTriangleMeshEndUpdateFB(XrTriangleMeshFB mesh, int vertexCount, int triangleCount)	End an update of the mesh data.
static int	xrTriangleMeshEndVertexBufferUpdateFB(XrTriangleMeshFB mesh)	End an update of the vertex data.
static int	xrTriangleMeshGetIndexBufferFB(XrTriangleMeshFB mesh, org.lwjgl.PointerBuffer outIndexBuffer)	Obtain the index buffer of a triangle mesh.
static int	xrTriangleMeshGetVertexBufferFB(XrTriangleMeshFB mesh, org.lwjgl.PointerBuffer outVertexBuffer)	Obtain the vertex buffer of a triangle mesh.

Methods inherited from class java.lang.Object

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

Field Details

XR_FB_triangle_mesh_SPEC_VERSION

public static final int XR_FB_triangle_mesh_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_FB_TRIANGLE_MESH_EXTENSION_NAME

public static final String XR_FB_TRIANGLE_MESH_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_TYPE_TRIANGLE_MESH_CREATE_INFO_FB

public static final int XR_TYPE_TRIANGLE_MESH_CREATE_INFO_FB

Extends XrStructureType.

See Also:

• Constant Field Values

XR_OBJECT_TYPE_TRIANGLE_MESH_FB

public static final int XR_OBJECT_TYPE_TRIANGLE_MESH_FB

Extends XrObjectType.

See Also:

• Constant Field Values

XR_TRIANGLE_MESH_MUTABLE_BIT_FB

public static final int XR_TRIANGLE_MESH_MUTABLE_BIT_FB

XrTriangleMeshFlagBitsFB - XrTriangleMeshFlagBitsFB

Flag Descriptions

• TRIANGLE_MESH_MUTABLE_BIT_FB — The triangle mesh is mutable (can be modified after it is created).

See Also:

• Constant Field Values

XR_WINDING_ORDER_UNKNOWN_FB

public static final int XR_WINDING_ORDER_UNKNOWN_FB

XrWindingOrderFB - Triangle winding order

Enumerant Descriptions

• WINDING_ORDER_UNKNOWN_FB — Winding order is unknown and the runtime cannot make any assumptions on the triangle orientation
• WINDING_ORDER_CW_FB — Clockwise winding order
• WINDING_ORDER_CCW_FB — Counter-clockwise winding order

See Also

XrTriangleMeshCreateInfoFB

See Also:

• Constant Field Values

XR_WINDING_ORDER_CW_FB

public static final int XR_WINDING_ORDER_CW_FB

XrWindingOrderFB - Triangle winding order

Enumerant Descriptions

• WINDING_ORDER_UNKNOWN_FB — Winding order is unknown and the runtime cannot make any assumptions on the triangle orientation
• WINDING_ORDER_CW_FB — Clockwise winding order
• WINDING_ORDER_CCW_FB — Counter-clockwise winding order

See Also

XrTriangleMeshCreateInfoFB

See Also:

• Constant Field Values

XR_WINDING_ORDER_CCW_FB

public static final int XR_WINDING_ORDER_CCW_FB

XrWindingOrderFB - Triangle winding order

Enumerant Descriptions

• WINDING_ORDER_UNKNOWN_FB — Winding order is unknown and the runtime cannot make any assumptions on the triangle orientation
• WINDING_ORDER_CW_FB — Clockwise winding order
• WINDING_ORDER_CCW_FB — Counter-clockwise winding order

See Also

XrTriangleMeshCreateInfoFB

See Also:

• Constant Field Values

Method Details

nxrCreateTriangleMeshFB

public static int nxrCreateTriangleMeshFB(XrSession session,
 long createInfo,
 long outTriangleMesh)

Unsafe version of: CreateTriangleMeshFB

xrCreateTriangleMeshFB

public static int xrCreateTriangleMeshFB(XrSession session,
 XrTriangleMeshCreateInfoFB createInfo,
 org.lwjgl.PointerBuffer outTriangleMesh)

Create a triangle mesh.

C Specification

The CreateTriangleMeshFB function is defined as:

 XrResult xrCreateTriangleMeshFB(
     XrSession                                   session,
     const XrTriangleMeshCreateInfoFB*           createInfo,
     XrTriangleMeshFB*                           outTriangleMesh);

Description

This creates an XrTriangleMeshFB handle. The returned triangle mesh handle may be subsequently used in API calls.

When the mesh is mutable (the TRIANGLE_MESH_MUTABLE_BIT_FB bit is set in XrTriangleMeshCreateInfoFB::flags), the created triangle mesh starts in the Undefined Topology state.

Immutable meshes have no state machine; they may be considered to be in state Ready with no valid edges leaving that state.

Valid Usage (Implicit)

• The XR_FB_triangle_mesh extension must be enabled prior to calling CreateTriangleMeshFB
• session must be a valid XrSession handle
• createInfo must be a pointer to a valid XrTriangleMeshCreateInfoFB structure
• outTriangleMesh must be a pointer to an XrTriangleMeshFB handle

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_OUT_OF_MEMORY
• ERROR_LIMIT_REACHED
• ERROR_INSUFFICIENT_RESOURCES_PASSTHROUGH_FB
• ERROR_FEATURE_UNSUPPORTED

See Also

XrTriangleMeshCreateInfoFB

Parameters:

session - the XrSession to which the mesh will belong.

createInfo - a pointer to an XrTriangleMeshCreateInfoFB structure containing parameters to be used to create the mesh.

outTriangleMesh - a pointer to a handle in which the created XrTriangleMeshFB is returned.

xrDestroyTriangleMeshFB

public static int xrDestroyTriangleMeshFB(XrTriangleMeshFB mesh)

Destroy a triangle mesh.

C Specification

The DestroyTriangleMeshFB function is defined as:

 XrResult xrDestroyTriangleMeshFB(
     XrTriangleMeshFB                            mesh);

Description

XrTriangleMeshFB handles and their associated data are destroyed by DestroyTriangleMeshFB. The mesh buffers retrieved by TriangleMeshGetVertexBufferFB and TriangleMeshGetIndexBufferFB must not be accessed anymore after their parent mesh object has been destroyed.

Valid Usage (Implicit)

• The XR_FB_triangle_mesh extension must be enabled prior to calling DestroyTriangleMeshFB
• mesh must be a valid XrTriangleMeshFB handle

Thread Safety

• Access to mesh, and any child handles, must be externally synchronized
• Access to the buffers returned from calls to TriangleMeshGetVertexBufferFB and TriangleMeshGetIndexBufferFB on mesh must be externally synchronized

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_FEATURE_UNSUPPORTED

Parameters:

mesh - the XrTriangleMeshFB to destroy.

nxrTriangleMeshGetVertexBufferFB

public static int nxrTriangleMeshGetVertexBufferFB(XrTriangleMeshFB mesh,
 long outVertexBuffer)

Unsafe version of: TriangleMeshGetVertexBufferFB

xrTriangleMeshGetVertexBufferFB

public static int xrTriangleMeshGetVertexBufferFB(XrTriangleMeshFB mesh,
 org.lwjgl.PointerBuffer outVertexBuffer)

Obtain the vertex buffer of a triangle mesh.

C Specification

The TriangleMeshGetVertexBufferFB function is defined as:

 XrResult xrTriangleMeshGetVertexBufferFB(
     XrTriangleMeshFB                            mesh,
     XrVector3f**                                outVertexBuffer);

Description

Retrieves a pointer to the vertex buffer. The vertex buffer is structured as an array of XrVector3f. The size of the buffer is XrTriangleMeshCreateInfoFB::vertexCount elements. The buffer location is guaranteed to remain constant over the lifecycle of the mesh object.

A mesh must be mutable and in a specific state for the application to modify it through the retrieved vertex buffer.

• A mutable triangle mesh must be in state Defining Topology, Updating Mesh, or Updating Vertices to modify the contents of the vertex buffer retrieved by this function.
• A mutable triangle mesh must be in state Defining Topology or Updating Mesh to modify the count of elements in the vertex buffer retrieved by this function. The new count is passed as a parameter to TriangleMeshEndUpdateFB.

Valid Usage (Implicit)

• The XR_FB_triangle_mesh extension must be enabled prior to calling TriangleMeshGetVertexBufferFB
• mesh must be a valid XrTriangleMeshFB handle
• outVertexBuffer must be a pointer to a pointer to an XrVector3f 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_FEATURE_UNSUPPORTED

See Also

XrVector3f, TriangleMeshGetIndexBufferFB

Parameters:

mesh - the XrTriangleMeshFB to get the vertex buffer for.

outVertexBuffer - a pointer to return the vertex buffer into.

nxrTriangleMeshGetIndexBufferFB

public static int nxrTriangleMeshGetIndexBufferFB(XrTriangleMeshFB mesh,
 long outIndexBuffer)

Unsafe version of: TriangleMeshGetIndexBufferFB

xrTriangleMeshGetIndexBufferFB

public static int xrTriangleMeshGetIndexBufferFB(XrTriangleMeshFB mesh,
 org.lwjgl.PointerBuffer outIndexBuffer)

Obtain the index buffer of a triangle mesh.

C Specification

The TriangleMeshGetIndexBufferFB function is defined as:

 XrResult xrTriangleMeshGetIndexBufferFB(
     XrTriangleMeshFB                            mesh,
     uint32_t**                                  outIndexBuffer);

Description

Retrieves a pointer to the index buffer that defines the topology of the triangle mesh. Each triplet of consecutive elements points to three vertices in the vertex buffer and thus form a triangle. The size of the index buffer is 3 * XrTriangleMeshCreateInfoFB::triangleCount elements. The buffer location is guaranteed to remain constant over the lifecycle of the mesh object.

A triangle mesh must be mutable and in state Defining Topology or Updating Mesh for the application to modify the contents and/or triangle count in the index buffer retrieved by this function.

Valid Usage (Implicit)

• The XR_FB_triangle_mesh extension must be enabled prior to calling TriangleMeshGetIndexBufferFB
• mesh must be a valid XrTriangleMeshFB handle
• outIndexBuffer must be a pointer to a pointer to a uint32_t value

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_FEATURE_UNSUPPORTED

See Also

TriangleMeshGetVertexBufferFB

Parameters:

mesh - the XrTriangleMeshFB to get the index buffer for.

outIndexBuffer - a pointer to return the index buffer into.

xrTriangleMeshBeginUpdateFB

public static int xrTriangleMeshBeginUpdateFB(XrTriangleMeshFB mesh)

Begin an update of the mesh data.

C Specification

The TriangleMeshBeginUpdateFB function is defined as:

 XrResult xrTriangleMeshBeginUpdateFB(
     XrTriangleMeshFB                            mesh);

Description

Begins updating the mesh buffer data. The application must call this function before it makes any modifications to the buffers retrieved by TriangleMeshGetVertexBufferFB and TriangleMeshGetIndexBufferFB. If only the vertex buffer contents need to be updated, and the mesh is in state Ready, TriangleMeshBeginVertexBufferUpdateFB may be used instead. To commit the modifications, the application must call TriangleMeshEndUpdateFB.

The triangle mesh mesh must be mutable. The runtime must return ERROR_VALIDATION_FAILURE if the mesh is immutable.

The triangle mesh mesh must be in state Undefined Topology or Ready.

• If the triangle mesh is in state Undefined Topology before this call, a successful call moves it to state Defining Topology.
• If the triangle mesh is in state Ready before this call, a successful call moves it to state Updating Mesh.

Valid Usage (Implicit)

• The XR_FB_triangle_mesh extension must be enabled prior to calling TriangleMeshBeginUpdateFB
• mesh must be a valid XrTriangleMeshFB handle

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_FEATURE_UNSUPPORTED
• ERROR_CALL_ORDER_INVALID

See Also

TriangleMeshEndUpdateFB

Parameters:

mesh - the XrTriangleMeshFB to update.

xrTriangleMeshEndUpdateFB

public static int xrTriangleMeshEndUpdateFB(XrTriangleMeshFB mesh,
 int vertexCount,
 int triangleCount)

End an update of the mesh data.

C Specification

The TriangleMeshEndUpdateFB function is defined as:

 XrResult xrTriangleMeshEndUpdateFB(
     XrTriangleMeshFB                            mesh,
     uint32_t                                    vertexCount,
     uint32_t                                    triangleCount);

Description

Signals to the runtime that the application has finished initially populating or updating the mesh buffers. vertexCount and triangleCount specify the actual number of primitives that make up the mesh after the update. They must be larger than zero but smaller or equal to the maximum counts defined at create time. The runtime must return ERROR_VALIDATION_FAILURE if an invalid count is passed.

The triangle mesh mesh must be mutable. The runtime must return ERROR_VALIDATION_FAILURE if the mesh is immutable.

The triangle mesh mesh must be in state Defining Topology or Updating Mesh.

A successful call moves mesh to state Ready.

Valid Usage (Implicit)

• The XR_FB_triangle_mesh extension must be enabled prior to calling TriangleMeshEndUpdateFB
• mesh must be a valid XrTriangleMeshFB handle

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_FEATURE_UNSUPPORTED
• ERROR_CALL_ORDER_INVALID

See Also

TriangleMeshBeginUpdateFB

Parameters:

mesh - the XrTriangleMeshFB to update.

vertexCount - the vertex count after the update.

triangleCount - the triangle count after the update.

nxrTriangleMeshBeginVertexBufferUpdateFB

public static int nxrTriangleMeshBeginVertexBufferUpdateFB(XrTriangleMeshFB mesh,
 long outVertexCount)

Unsafe version of: TriangleMeshBeginVertexBufferUpdateFB

xrTriangleMeshBeginVertexBufferUpdateFB

public static int xrTriangleMeshBeginVertexBufferUpdateFB(XrTriangleMeshFB mesh,
 IntBuffer outVertexCount)

Begin an update of the vertex data.

C Specification

The TriangleMeshBeginVertexBufferUpdateFB function is defined as:

 XrResult xrTriangleMeshBeginVertexBufferUpdateFB(
     XrTriangleMeshFB                            mesh,
     uint32_t*                                   outVertexCount);

Description

Begins an update of the vertex positions of a mutable triangle mesh. The vertex count returned through outVertexCount is defined by the last call to TriangleMeshEndUpdateFB. Once the modification is done, call TriangleMeshEndVertexBufferUpdateFB to commit the changes and move to state Ready.

The triangle mesh mesh must be mutable. The runtime must return ERROR_VALIDATION_FAILURE if the mesh is immutable.

The triangle mesh mesh must be in state Ready.

A successful call moves mesh to state Updating Vertices.

Valid Usage (Implicit)

• The XR_FB_triangle_mesh extension must be enabled prior to calling TriangleMeshBeginVertexBufferUpdateFB
• mesh must be a valid XrTriangleMeshFB handle
• outVertexCount must be a pointer to a uint32_t value

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_FEATURE_UNSUPPORTED
• ERROR_CALL_ORDER_INVALID

See Also

TriangleMeshBeginUpdateFB, TriangleMeshEndVertexBufferUpdateFB

Parameters:

mesh - the XrTriangleMeshFB to update.

outVertexCount - a pointer to a value to populate with the current vertex count. The updated data must have the exact same number of vertices.

xrTriangleMeshEndVertexBufferUpdateFB

public static int xrTriangleMeshEndVertexBufferUpdateFB(XrTriangleMeshFB mesh)

End an update of the vertex data.

C Specification

The TriangleMeshEndVertexBufferUpdateFB function is defined as:

 XrResult xrTriangleMeshEndVertexBufferUpdateFB(
     XrTriangleMeshFB                            mesh);

Description

Signals to the runtime that the application has finished updating the vertex buffer data following a call to TriangleMeshBeginVertexBufferUpdateFB.

The triangle mesh mesh must be mutable. The runtime must return ERROR_VALIDATION_FAILURE if the mesh is immutable.

The triangle mesh mesh must be in state Updating Vertices.

A successful call moves mesh to state Ready.

Valid Usage (Implicit)

• The XR_FB_triangle_mesh extension must be enabled prior to calling TriangleMeshEndVertexBufferUpdateFB
• mesh must be a valid XrTriangleMeshFB handle

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_FEATURE_UNSUPPORTED
• ERROR_CALL_ORDER_INVALID

See Also

TriangleMeshBeginVertexBufferUpdateFB

Parameters:

mesh - the XrTriangleMeshFB to update.