public Class HTCPassthrough

The extension name.

The extension specification version.

Extends XrObjectType.

XrPassthroughFormHTC - Describes the form of passthrough.

Enumerant Descriptions

• PASSTHROUGH_FORM_PLANAR_HTC — Presents the passthrough with full of the entire screen.
• PASSTHROUGH_FORM_PROJECTED_HTC — Presents the passthrough projecting onto a custom mesh.

See Also

XrPassthroughCreateInfoHTC

XrPassthroughFormHTC - Describes the form of passthrough.

Enumerant Descriptions

• PASSTHROUGH_FORM_PLANAR_HTC — Presents the passthrough with full of the entire screen.
• PASSTHROUGH_FORM_PROJECTED_HTC — Presents the passthrough projecting onto a custom mesh.

See Also

XrPassthroughCreateInfoHTC

Extends XrStructureType.

Enum values:

• TYPE_PASSTHROUGH_CREATE_INFO_HTC
• TYPE_PASSTHROUGH_COLOR_HTC
• TYPE_PASSTHROUGH_MESH_TRANSFORM_INFO_HTC
• TYPE_COMPOSITION_LAYER_PASSTHROUGH_HTC

Extends XrStructureType.

Enum values:

• TYPE_PASSTHROUGH_CREATE_INFO_HTC
• TYPE_PASSTHROUGH_COLOR_HTC
• TYPE_PASSTHROUGH_MESH_TRANSFORM_INFO_HTC
• TYPE_COMPOSITION_LAYER_PASSTHROUGH_HTC

Extends XrStructureType.

Enum values:

• TYPE_PASSTHROUGH_CREATE_INFO_HTC
• TYPE_PASSTHROUGH_COLOR_HTC
• TYPE_PASSTHROUGH_MESH_TRANSFORM_INFO_HTC
• TYPE_COMPOSITION_LAYER_PASSTHROUGH_HTC

Extends XrStructureType.

Enum values:

• TYPE_PASSTHROUGH_CREATE_INFO_HTC
• TYPE_PASSTHROUGH_COLOR_HTC
• TYPE_PASSTHROUGH_MESH_TRANSFORM_INFO_HTC
• TYPE_COMPOSITION_LAYER_PASSTHROUGH_HTC

Unsafe version of: CreatePassthroughHTC

Create a passthrough handle.

C Specification

The CreatePassthroughHTC function is defined as:

XrResult xrCreatePassthroughHTC(
    XrSession                                   session,
    const XrPassthroughCreateInfoHTC*           createInfo,
    XrPassthroughHTC*                           passthrough);

Description

Creates an XrPassthroughHTC handle.

If the function successfully returned, the output passthrough must be a valid handle.

Valid Usage (Implicit)

• The XR_HTC_passthrough extension must be enabled prior to calling CreatePassthroughHTC
• session must be a valid XrSession handle
• createInfo must be a pointer to a valid XrPassthroughCreateInfoHTC structure
• passthrough must be a pointer to an XrPassthroughHTC 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_FEATURE_UNSUPPORTED

See Also

XrPassthroughCreateInfoHTC

Parameters

session:XrSession

an XrSession in which the passthrough will be active.

createInfo:XrPassthroughCreateInfoHTC

a pointer to an XrPassthroughCreateInfoHTC structure containing information about how to create the passthrough.

passthrough:PointerBuffer

a pointer to a handle in which the created XrPassthroughHTC is returned.

Annotations

@NativeType:XrResult

Destroy a passthrough handle.

C Specification

The DestroyPassthroughHTC function is defined as:

XrResult xrDestroyPassthroughHTC(
    XrPassthroughHTC                            passthrough);

Description

The DestroyPassthroughHTC function releases the passthrough and the underlying resources.

Valid Usage (Implicit)

• The XR_HTC_passthrough extension must be enabled prior to calling DestroyPassthroughHTC
• passthrough must be a valid XrPassthroughHTC handle

Thread Safety

• Access to passthrough, and any child handles, 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

Parameters

passthrough:XrPassthroughHTC

the XrPassthroughHTC to be destroyed.

Annotations

@NativeType:XrResult