vkGetSemaphoreZirconHandleFUCHSIA - Get a Zircon event handle for a semaphore

Description

Each call to getSemaphoreZirconHandleFUCHSIA must create a Zircon event handle and transfer ownership of it to the application. To avoid leaking resources, the application must release ownership of the Zircon event handle when it is no longer needed.

Note

Ownership can be released in many ways. For example, the application can call zx_handle_close() on the file descriptor, or transfer ownership back to Vulkan by using the file descriptor to import a semaphore payload.

Exporting a Zircon event handle from a semaphore may have side effects depending on the transference of the specified handle type, as described in Importing Semaphore State.

Return Codes

Success

• SUCCESS

Failure

• ERROR_TOO_MANY_OBJECTS
• ERROR_OUT_OF_HOST_MEMORY

See Also

VK_FUCHSIA_external_semaphore, Device, SemaphoreGetZirconHandleInfoFUCHSIA

vkImportSemaphoreZirconHandleFUCHSIA - Import a semaphore from a Zircon event handle

Description

Importing a semaphore payload from a Zircon event handle transfers ownership of the handle from the application to the Vulkan implementation. The application must not perform any operations on the handle after a successful import.

Applications can import the same semaphore payload into multiple instances of Vulkan, into the same instance from which it was exported, and multiple times into a given Vulkan instance.

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_INVALID_EXTERNAL_HANDLE

See Also

VK_FUCHSIA_external_semaphore, Device, ImportSemaphoreZirconHandleInfoFUCHSIA

VkImportSemaphoreZirconHandleInfoFUCHSIA - Structure specifying Zircon event handle to import to a semaphore

Description

The handle types supported by handleType are:

Handle Types Supported by ImportSemaphoreZirconHandleInfoFUCHSIA

Valid Usage

• handleType must be a value included in the Handle Types Supported by table

• zirconHandle must obey any requirements listed for handleType in external semaphore handle types compatibility
• zirconHandle must have ZX_RIGHTS_BASIC and ZX_RIGHTS_SIGNAL rights
• The SemaphoreTypeCreateInfo::semaphoreType field must not be SEMAPHORE_TYPE_TIMELINE

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_IMPORT_SEMAPHORE_ZIRCON_HANDLE_INFO_FUCHSIA

• pNext must be NULL
• semaphore must be a valid Semaphore handle
• flags must be a valid combination of SemaphoreImportFlagBits values
• handleType must be a valid ExternalSemaphoreHandleTypeFlagBits value

Host Synchronization

• Host access to semaphore must be externally synchronized

See Also

VK_FUCHSIA_external_semaphore, ExternalSemaphoreHandleTypeFlagBits, Semaphore, SemaphoreImportFlags, StructureType, importSemaphoreZirconHandleFUCHSIA

VkSemaphoreGetZirconHandleInfoFUCHSIA - Structure describing a Zircon event handle semaphore export operation

Description

The properties of the Zircon event handle returned depend on the value of handleType. See ExternalSemaphoreHandleTypeFlagBits for a description of the properties of the defined external semaphore handle types.

Valid Usage

• handleType must have been included in ExportSemaphoreCreateInfo::handleTypes when semaphore’s current payload was created

• semaphore must not currently have its payload replaced by an imported payload as described below in Importing Semaphore Payloads unless that imported payload’s handle type was included in ExternalSemaphoreProperties::exportFromImportedHandleTypes for handleType
• If handleType refers to a handle type with copy payload transference semantics, as defined below in Importing Semaphore Payloads, there must be no queue waiting on semaphore
• If handleType refers to a handle type with copy payload transference semantics, semaphore must be signaled, or have an associated semaphore signal operation pending execution
• handleType must be defined as a Zircon event handle
• semaphore must have been created with a SemaphoreType of SEMAPHORE_TYPE_BINARY

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_SEMAPHORE_GET_ZIRCON_HANDLE_INFO_FUCHSIA

• pNext must be NULL
• semaphore must be a valid Semaphore handle
• handleType must be a valid ExternalSemaphoreHandleTypeFlagBits value

See Also

VK_FUCHSIA_external_semaphore, ExternalSemaphoreHandleTypeFlagBits, Semaphore, StructureType, getSemaphoreZirconHandleFUCHSIA