Vulkan.Extensions.VK_FUCHSIA_external_semaphore

Name

VK_FUCHSIA_external_semaphore - device extension

VK_FUCHSIA_external_semaphore

Name String

VK_FUCHSIA_external_semaphore

Extension Type

Device extension

Registered Extension Number

366

Revision

1

Extension and Version Dependencies

• Requires support for Vulkan 1.0
• Requires VK_KHR_external_semaphore_capabilities to be enabled for any device-level functionality
• Requires VK_KHR_external_semaphore to be enabled for any device-level functionality

Contact

• John Rosasco @rosasco%0A*Here describe the issue or question you have about the VK_FUCHSIA_external_semaphore extension*

Other Extension Metadata

Last Modified Date

2021-03-08

IP Status

No known IP claims.

Contributors

• Craig Stout, Google
• John Bauman, Google
• John Rosasco, Google

Description

An application using external memory may wish to synchronize access to that memory using semaphores. This extension enables an application to export semaphore payload to and import semaphore payload from Zircon event handles.

New Commands

• getSemaphoreZirconHandleFUCHSIA

• importSemaphoreZirconHandleFUCHSIA

New Structures

• ImportSemaphoreZirconHandleInfoFUCHSIA

• SemaphoreGetZirconHandleInfoFUCHSIA

New Enum Constants

• FUCHSIA_EXTERNAL_SEMAPHORE_EXTENSION_NAME

• FUCHSIA_EXTERNAL_SEMAPHORE_SPEC_VERSION

• Extending ExternalSemaphoreHandleTypeFlagBits:

  • EXTERNAL_SEMAPHORE_HANDLE_TYPE_ZIRCON_EVENT_BIT_FUCHSIA

• Extending StructureType:

  • STRUCTURE_TYPE_IMPORT_SEMAPHORE_ZIRCON_HANDLE_INFO_FUCHSIA
  • STRUCTURE_TYPE_SEMAPHORE_GET_ZIRCON_HANDLE_INFO_FUCHSIA

Issues

1) Does the application need to close the Zircon event handle returned by getSemaphoreZirconHandleFUCHSIA?

RESOLVED: Yes, unless it is passed back in to a driver instance to import the semaphore. A successful get call transfers ownership of the Zircon event handle to the application, and a successful import transfers it back to the driver. Destroying the original semaphore object will not close the Zircon event handle nor remove its reference to the underlying semaphore resource associated with it.

Version History

• Revision 1, 2021-03-08 (John Rosasco)

  • Initial revision

See Also

ImportSemaphoreZirconHandleInfoFUCHSIA, SemaphoreGetZirconHandleInfoFUCHSIA, getSemaphoreZirconHandleFUCHSIA, importSemaphoreZirconHandleFUCHSIA

Document Notes

For more information, see the Vulkan Specification

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

Documentation

getSemaphoreZirconHandleFUCHSIA

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device that created the semaphore being exported.

device must be a valid Device handle

-> SemaphoreGetZirconHandleInfoFUCHSIA

pGetZirconHandleInfo is a pointer to a SemaphoreGetZirconHandleInfoFUCHSIA structure containing parameters of the export operation.

pGetZirconHandleInfo must be a valid pointer to a valid SemaphoreGetZirconHandleInfoFUCHSIA structure

-> io ("zirconHandle" ::: Zx_handle_t)

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

importSemaphoreZirconHandleFUCHSIA

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device that created the semaphore.

device must be a valid Device handle

-> ImportSemaphoreZirconHandleInfoFUCHSIA

pImportSemaphoreZirconHandleInfo is a pointer to a ImportSemaphoreZirconHandleInfoFUCHSIA structure specifying the semaphore and import parameters.

pImportSemaphoreZirconHandleInfo must be a valid pointer to a valid ImportSemaphoreZirconHandleInfoFUCHSIA structure

-> io ()

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

data ImportSemaphoreZirconHandleInfoFUCHSIA

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

Description

The handle types supported by handleType are:

Handle Type	Transference	Permanence Supported
EXTERNAL_SEMAPHORE_HANDLE_TYPE_ZIRCON_EVENT_BIT_FUCHSIA	Reference	Temporary,Permanent

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

Constructors

ImportSemaphoreZirconHandleInfoFUCHSIA

Fields

• semaphore :: Semaphore

  semaphore is the semaphore into which the payload will be imported.

• flags :: SemaphoreImportFlags

  flags is a bitmask of SemaphoreImportFlagBits specifying additional parameters for the semaphore payload import operation.

• handleType :: ExternalSemaphoreHandleTypeFlagBits

  handleType is a ExternalSemaphoreHandleTypeFlagBits value specifying the type of zirconHandle.

• zirconHandle :: Zx_handle_t

  zirconHandle is the external handle to import.

Instances

Storable ImportSemaphoreZirconHandleInfoFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_external_semaphore

Methods

sizeOf :: ImportSemaphoreZirconHandleInfoFUCHSIA -> Int

alignment :: ImportSemaphoreZirconHandleInfoFUCHSIA -> Int

peekElemOff :: Ptr ImportSemaphoreZirconHandleInfoFUCHSIA -> Int -> IO ImportSemaphoreZirconHandleInfoFUCHSIA

pokeElemOff :: Ptr ImportSemaphoreZirconHandleInfoFUCHSIA -> Int -> ImportSemaphoreZirconHandleInfoFUCHSIA -> IO ()

peekByteOff :: Ptr b -> Int -> IO ImportSemaphoreZirconHandleInfoFUCHSIA

pokeByteOff :: Ptr b -> Int -> ImportSemaphoreZirconHandleInfoFUCHSIA -> IO ()

peek :: Ptr ImportSemaphoreZirconHandleInfoFUCHSIA -> IO ImportSemaphoreZirconHandleInfoFUCHSIA

poke :: Ptr ImportSemaphoreZirconHandleInfoFUCHSIA -> ImportSemaphoreZirconHandleInfoFUCHSIA -> IO ()

Show ImportSemaphoreZirconHandleInfoFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_external_semaphore

Methods

showsPrec :: Int -> ImportSemaphoreZirconHandleInfoFUCHSIA -> ShowS

show :: ImportSemaphoreZirconHandleInfoFUCHSIA -> String

showList :: [ImportSemaphoreZirconHandleInfoFUCHSIA] -> ShowS

Eq ImportSemaphoreZirconHandleInfoFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_external_semaphore

Methods

(==) :: ImportSemaphoreZirconHandleInfoFUCHSIA -> ImportSemaphoreZirconHandleInfoFUCHSIA -> Bool

(/=) :: ImportSemaphoreZirconHandleInfoFUCHSIA -> ImportSemaphoreZirconHandleInfoFUCHSIA -> Bool

FromCStruct ImportSemaphoreZirconHandleInfoFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_external_semaphore

Methods

peekCStruct :: Ptr ImportSemaphoreZirconHandleInfoFUCHSIA -> IO ImportSemaphoreZirconHandleInfoFUCHSIA

ToCStruct ImportSemaphoreZirconHandleInfoFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_external_semaphore

Methods

withCStruct :: ImportSemaphoreZirconHandleInfoFUCHSIA -> (Ptr ImportSemaphoreZirconHandleInfoFUCHSIA -> IO b) -> IO b

pokeCStruct :: Ptr ImportSemaphoreZirconHandleInfoFUCHSIA -> ImportSemaphoreZirconHandleInfoFUCHSIA -> IO b -> IO b

withZeroCStruct :: (Ptr ImportSemaphoreZirconHandleInfoFUCHSIA -> IO b) -> IO b

pokeZeroCStruct :: Ptr ImportSemaphoreZirconHandleInfoFUCHSIA -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero ImportSemaphoreZirconHandleInfoFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_external_semaphore

Methods

zero :: ImportSemaphoreZirconHandleInfoFUCHSIA

data SemaphoreGetZirconHandleInfoFUCHSIA

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

Constructors

SemaphoreGetZirconHandleInfoFUCHSIA

Fields

• semaphore :: Semaphore

  semaphore is the semaphore from which state will be exported.

• handleType :: ExternalSemaphoreHandleTypeFlagBits

  handleType is a ExternalSemaphoreHandleTypeFlagBits value specifying the type of handle requested.

Instances

Storable SemaphoreGetZirconHandleInfoFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_external_semaphore

Methods

sizeOf :: SemaphoreGetZirconHandleInfoFUCHSIA -> Int

alignment :: SemaphoreGetZirconHandleInfoFUCHSIA -> Int

peekElemOff :: Ptr SemaphoreGetZirconHandleInfoFUCHSIA -> Int -> IO SemaphoreGetZirconHandleInfoFUCHSIA

pokeElemOff :: Ptr SemaphoreGetZirconHandleInfoFUCHSIA -> Int -> SemaphoreGetZirconHandleInfoFUCHSIA -> IO ()

peekByteOff :: Ptr b -> Int -> IO SemaphoreGetZirconHandleInfoFUCHSIA

pokeByteOff :: Ptr b -> Int -> SemaphoreGetZirconHandleInfoFUCHSIA -> IO ()

peek :: Ptr SemaphoreGetZirconHandleInfoFUCHSIA -> IO SemaphoreGetZirconHandleInfoFUCHSIA

poke :: Ptr SemaphoreGetZirconHandleInfoFUCHSIA -> SemaphoreGetZirconHandleInfoFUCHSIA -> IO ()

Show SemaphoreGetZirconHandleInfoFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_external_semaphore

Methods

showsPrec :: Int -> SemaphoreGetZirconHandleInfoFUCHSIA -> ShowS

show :: SemaphoreGetZirconHandleInfoFUCHSIA -> String

showList :: [SemaphoreGetZirconHandleInfoFUCHSIA] -> ShowS

Eq SemaphoreGetZirconHandleInfoFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_external_semaphore

Methods

(==) :: SemaphoreGetZirconHandleInfoFUCHSIA -> SemaphoreGetZirconHandleInfoFUCHSIA -> Bool

(/=) :: SemaphoreGetZirconHandleInfoFUCHSIA -> SemaphoreGetZirconHandleInfoFUCHSIA -> Bool

FromCStruct SemaphoreGetZirconHandleInfoFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_external_semaphore

Methods

peekCStruct :: Ptr SemaphoreGetZirconHandleInfoFUCHSIA -> IO SemaphoreGetZirconHandleInfoFUCHSIA

ToCStruct SemaphoreGetZirconHandleInfoFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_external_semaphore

Methods

withCStruct :: SemaphoreGetZirconHandleInfoFUCHSIA -> (Ptr SemaphoreGetZirconHandleInfoFUCHSIA -> IO b) -> IO b

pokeCStruct :: Ptr SemaphoreGetZirconHandleInfoFUCHSIA -> SemaphoreGetZirconHandleInfoFUCHSIA -> IO b -> IO b

withZeroCStruct :: (Ptr SemaphoreGetZirconHandleInfoFUCHSIA -> IO b) -> IO b

pokeZeroCStruct :: Ptr SemaphoreGetZirconHandleInfoFUCHSIA -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero SemaphoreGetZirconHandleInfoFUCHSIA

Defined in Vulkan.Extensions.VK_FUCHSIA_external_semaphore

Methods

zero :: SemaphoreGetZirconHandleInfoFUCHSIA

type FUCHSIA_EXTERNAL_SEMAPHORE_SPEC_VERSION = 1

pattern FUCHSIA_EXTERNAL_SEMAPHORE_SPEC_VERSION :: forall a. Integral a => a

type FUCHSIA_EXTERNAL_SEMAPHORE_EXTENSION_NAME = "VK_FUCHSIA_external_semaphore"

pattern FUCHSIA_EXTERNAL_SEMAPHORE_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

type Zx_handle_t = Word32