Safe Haskell	None
Language	Haskell2010

Vulkan.Extensions.VK_KHR_external_fence_fd

Description

Name

VK_KHR_external_fence_fd - device extension

VK_KHR_external_fence_fd

Name String: VK_KHR_external_fence_fd

Extension Type

Device extension

Registered Extension Number

116

Revision

1

Extension and Version Dependencies

Requires Vulkan 1.0
Requires VK_KHR_external_fence

Contact

Jesse Hall https://github.com/KhronosGroup/Vulkan-Docs/issues/new?title=VK_KHR_external_fence_fd:%20&body=@critsec%20

Other Extension Metadata

Last Modified Date: 2017-05-08

IP Status

No known IP claims.

Contributors

Jesse Hall, Google
James Jones, NVIDIA
Jeff Juliano, NVIDIA
Cass Everitt, Oculus
Contributors to VK_KHR_external_semaphore_fd

Description

An application using external memory may wish to synchronize access to that memory using fences. This extension enables an application to export fence payload to and import fence payload from POSIX file descriptors.

New Commands

getFenceFdKHR

importFenceFdKHR

New Structures

FenceGetFdInfoKHR

ImportFenceFdInfoKHR

New Enum Constants

KHR_EXTERNAL_FENCE_FD_EXTENSION_NAME

KHR_EXTERNAL_FENCE_FD_SPEC_VERSION
Extending StructureType:
- STRUCTURE_TYPE_FENCE_GET_FD_INFO_KHR
- STRUCTURE_TYPE_IMPORT_FENCE_FD_INFO_KHR

Issues

This extension borrows concepts, semantics, and language from VK_KHR_external_semaphore_fd. That extension’s issues apply equally to this extension.

Version History

Revision 1, 2017-05-08 (Jesse Hall)
- Initial revision

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.

Synopsis

getFenceFdKHR :: forall io. MonadIO io => Device -> FenceGetFdInfoKHR -> io ("fd" ::: Int32)
importFenceFdKHR :: forall io. MonadIO io => Device -> ImportFenceFdInfoKHR -> io ()
data ImportFenceFdInfoKHR = ImportFenceFdInfoKHR {
- fence :: Fence
- flags :: FenceImportFlags
- handleType :: ExternalFenceHandleTypeFlagBits
- fd :: Int32
}
data FenceGetFdInfoKHR = FenceGetFdInfoKHR {
- fence :: Fence
- handleType :: ExternalFenceHandleTypeFlagBits
}
type KHR_EXTERNAL_FENCE_FD_SPEC_VERSION = 1
pattern KHR_EXTERNAL_FENCE_FD_SPEC_VERSION :: forall a. Integral a => a
type KHR_EXTERNAL_FENCE_FD_EXTENSION_NAME = "VK_KHR_external_fence_fd"
pattern KHR_EXTERNAL_FENCE_FD_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

Documentation

getFenceFdKHR Source #

Arguments

:: forall io. MonadIO io
=> Device	`device` is the logical device that created the fence being exported. `device` must be a valid `Device` handle
-> FenceGetFdInfoKHR	`pGetFdInfo` is a pointer to a `FenceGetFdInfoKHR` structure containing parameters of the export operation. `pGetFdInfo` must be a valid pointer to a valid `FenceGetFdInfoKHR` structure
-> io ("fd" ::: Int32)

vkGetFenceFdKHR - Get a POSIX file descriptor handle for a fence

Description

Each call to getFenceFdKHR must create a new file descriptor and transfer ownership of it to the application. To avoid leaking resources, the application must release ownership of the file descriptor when it is no longer needed.

Note

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

If pGetFdInfo->handleType is EXTERNAL_FENCE_HANDLE_TYPE_SYNC_FD_BIT and the fence is signaled at the time getFenceFdKHR is called, pFd may return the value -1 instead of a valid file descriptor.

Where supported by the operating system, the implementation must set the file descriptor to be closed automatically when an execve system call is made.

Exporting a file descriptor from a fence may have side effects depending on the transference of the specified handle type, as described in Importing Fence State.

Return Codes

Success

SUCCESS

Failure

Description

Importing a fence payload from a file descriptor transfers ownership of the file descriptor from the application to the Vulkan implementation. The application must not perform any operations on the file descriptor after a successful import.

Applications can import the same fence 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

Description

The handle types supported by handleType are:

Handle Type	Transference	Permanence Supported
`EXTERNAL_FENCE_HANDLE_TYPE_OPAQUE_FD_BIT`	Reference	Temporary,Permanent
`EXTERNAL_FENCE_HANDLE_TYPE_SYNC_FD_BIT`	Copy	Temporary

Handle Types Supported by ImportFenceFdInfoKHR

Valid Usage

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

fd must obey any requirements listed for handleType in external fence handle types compatibility

If handleType is EXTERNAL_FENCE_HANDLE_TYPE_SYNC_FD_BIT, the special value -1 for fd is treated like a valid sync file descriptor referring to an object that has already signaled. The import operation will succeed and the Fence will have a temporarily imported payload as if a valid file descriptor had been provided.

Note

This special behavior for importing an invalid sync file descriptor allows easier interoperability with other system APIs which use the convention that an invalid sync file descriptor represents work that has already completed and does not need to be waited for. It is consistent with the option for implementations to return a -1 file descriptor when exporting a EXTERNAL_FENCE_HANDLE_TYPE_SYNC_FD_BIT from a Fence which is signaled.

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_IMPORT_FENCE_FD_INFO_KHR

pNext must be NULL
fence must be a valid Fence handle
flags must be a valid combination of FenceImportFlagBits values
handleType must be a valid ExternalFenceHandleTypeFlagBits value

Host Synchronization

Host access to fence must be externally synchronized

ImportFenceFdInfoKHR
Fields fence :: Fence `fence` is the fence into which the payload will be imported. flags :: FenceImportFlags `flags` is a bitmask of `FenceImportFlagBits` specifying additional parameters for the fence payload import operation. handleType :: ExternalFenceHandleTypeFlagBits `handleType` specifies the type of `fd`. fd :: Int32 `fd` is the external handle to import.

Instances

Instances details

Eq ImportFenceFdInfoKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_external_fence_fd Methods (==) :: ImportFenceFdInfoKHR -> ImportFenceFdInfoKHR -> Bool # (/=) :: ImportFenceFdInfoKHR -> ImportFenceFdInfoKHR -> Bool #
Show ImportFenceFdInfoKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_external_fence_fd Methods showsPrec :: Int -> ImportFenceFdInfoKHR -> ShowS # show :: ImportFenceFdInfoKHR -> String # showList :: [ImportFenceFdInfoKHR] -> ShowS #
Storable ImportFenceFdInfoKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_external_fence_fd Methods sizeOf :: ImportFenceFdInfoKHR -> Int # alignment :: ImportFenceFdInfoKHR -> Int # peekElemOff :: Ptr ImportFenceFdInfoKHR -> Int -> IO ImportFenceFdInfoKHR # pokeElemOff :: Ptr ImportFenceFdInfoKHR -> Int -> ImportFenceFdInfoKHR -> IO () # peekByteOff :: Ptr b -> Int -> IO ImportFenceFdInfoKHR # pokeByteOff :: Ptr b -> Int -> ImportFenceFdInfoKHR -> IO () # peek :: Ptr ImportFenceFdInfoKHR -> IO ImportFenceFdInfoKHR # poke :: Ptr ImportFenceFdInfoKHR -> ImportFenceFdInfoKHR -> IO () #
FromCStruct ImportFenceFdInfoKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_external_fence_fd Methods peekCStruct :: Ptr ImportFenceFdInfoKHR -> IO ImportFenceFdInfoKHR Source #
ToCStruct ImportFenceFdInfoKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_external_fence_fd Methods withCStruct :: ImportFenceFdInfoKHR -> (Ptr ImportFenceFdInfoKHR -> IO b) -> IO b Source # pokeCStruct :: Ptr ImportFenceFdInfoKHR -> ImportFenceFdInfoKHR -> IO b -> IO b Source # withZeroCStruct :: (Ptr ImportFenceFdInfoKHR -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr ImportFenceFdInfoKHR -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero ImportFenceFdInfoKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_external_fence_fd Methods zero :: ImportFenceFdInfoKHR Source #

data FenceGetFdInfoKHR Source #

VkFenceGetFdInfoKHR - Structure describing a POSIX FD fence export operation

Description

The properties of the file descriptor returned depend on the value of handleType. See ExternalFenceHandleTypeFlagBits for a description of the properties of the defined external fence handle types.

Valid Usage

handleType must have been included in ExportFenceCreateInfo::handleTypes when fence’s current payload was created

If handleType refers to a handle type with copy payload transference semantics, fence must be signaled, or have an associated fence signal operation pending execution
fence must not currently have its payload replaced by an imported payload as described below in Importing Fence Payloads unless that imported payload’s handle type was included in ExternalFenceProperties::exportFromImportedHandleTypes for handleType
handleType must be defined as a POSIX file descriptor handle

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_FENCE_GET_FD_INFO_KHR

pNext must be NULL
fence must be a valid Fence handle
handleType must be a valid ExternalFenceHandleTypeFlagBits value

Eq FenceGetFdInfoKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_external_fence_fd Methods (==) :: FenceGetFdInfoKHR -> FenceGetFdInfoKHR -> Bool # (/=) :: FenceGetFdInfoKHR -> FenceGetFdInfoKHR -> Bool #
Show FenceGetFdInfoKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_external_fence_fd Methods showsPrec :: Int -> FenceGetFdInfoKHR -> ShowS # show :: FenceGetFdInfoKHR -> String # showList :: [FenceGetFdInfoKHR] -> ShowS #
Storable FenceGetFdInfoKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_external_fence_fd Methods sizeOf :: FenceGetFdInfoKHR -> Int # alignment :: FenceGetFdInfoKHR -> Int # peekElemOff :: Ptr FenceGetFdInfoKHR -> Int -> IO FenceGetFdInfoKHR # pokeElemOff :: Ptr FenceGetFdInfoKHR -> Int -> FenceGetFdInfoKHR -> IO () # peekByteOff :: Ptr b -> Int -> IO FenceGetFdInfoKHR # pokeByteOff :: Ptr b -> Int -> FenceGetFdInfoKHR -> IO () # peek :: Ptr FenceGetFdInfoKHR -> IO FenceGetFdInfoKHR # poke :: Ptr FenceGetFdInfoKHR -> FenceGetFdInfoKHR -> IO () #
FromCStruct FenceGetFdInfoKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_external_fence_fd Methods peekCStruct :: Ptr FenceGetFdInfoKHR -> IO FenceGetFdInfoKHR Source #
ToCStruct FenceGetFdInfoKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_external_fence_fd Methods withCStruct :: FenceGetFdInfoKHR -> (Ptr FenceGetFdInfoKHR -> IO b) -> IO b Source # pokeCStruct :: Ptr FenceGetFdInfoKHR -> FenceGetFdInfoKHR -> IO b -> IO b Source # withZeroCStruct :: (Ptr FenceGetFdInfoKHR -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr FenceGetFdInfoKHR -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero FenceGetFdInfoKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_external_fence_fd Methods zero :: FenceGetFdInfoKHR Source #

Name

VK_KHR_external_fence_fd

Other Extension Metadata

Description

New Commands

New Structures

New Enum Constants

Issues

Version History

See Also

Document Notes

Documentation

Description

Return Codes

See Also

Description

Return Codes

See Also

Description

Valid Usage

Valid Usage (Implicit)

Host Synchronization

See Also

Instances

Description

Valid Usage

Valid Usage (Implicit)

See Also

Instances

FenceGetFdInfoKHR
Fields fence :: Fence `fence` is the fence from which state will be exported. handleType :: ExternalFenceHandleTypeFlagBits `handleType` is the type of handle requested.