Vulkan.Extensions.VK_KHR_external_semaphore_win32

Documentation

getSemaphoreWin32HandleKHR

Arguments

:: forall io. MonadIO io

=> Device

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

device must be a valid Device handle

-> SemaphoreGetWin32HandleInfoKHR

pGetWin32HandleInfo is a pointer to a SemaphoreGetWin32HandleInfoKHR structure containing parameters of the export operation.

pGetWin32HandleInfo must be a valid pointer to a valid SemaphoreGetWin32HandleInfoKHR structure

-> io HANDLE

vkGetSemaphoreWin32HandleKHR - Get a Windows HANDLE for a semaphore

Description

For handle types defined as NT handles, the handles returned by getSemaphoreWin32HandleKHR are owned by the application. To avoid leaking resources, the application must release ownership of them using the CloseHandle system call when they are no longer needed.

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

Return Codes

Success

• SUCCESS

Failure

• ERROR_TOO_MANY_OBJECTS
• ERROR_OUT_OF_HOST_MEMORY

See Also

Device, SemaphoreGetWin32HandleInfoKHR

importSemaphoreWin32HandleKHR

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device that created the semaphore.

device must be a valid Device handle

-> ImportSemaphoreWin32HandleInfoKHR

pImportSemaphoreWin32HandleInfo is a pointer to a ImportSemaphoreWin32HandleInfoKHR structure specifying the semaphore and import parameters.

pImportSemaphoreWin32HandleInfo must be a valid pointer to a valid ImportSemaphoreWin32HandleInfoKHR structure

-> io ()

vkImportSemaphoreWin32HandleKHR - Import a semaphore from a Windows HANDLE

Description

Importing a semaphore payload from Windows handles does not transfer ownership of the handle to the Vulkan implementation. For handle types defined as NT handles, the application must release ownership using the CloseHandle system call when the handle is no longer needed.

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

Device, ImportSemaphoreWin32HandleInfoKHR

data ImportSemaphoreWin32HandleInfoKHR

VkImportSemaphoreWin32HandleInfoKHR - Structure specifying Windows handle to import to a semaphore

Description

The handle types supported by handleType are:

Handle Type	Transference	Permanence Supported
EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_BIT	Reference	Temporary,Permanent
EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT	Reference	Temporary,Permanent
EXTERNAL_SEMAPHORE_HANDLE_TYPE_D3D12_FENCE_BIT	Reference	Temporary,Permanent

Handle Types Supported by ImportSemaphoreWin32HandleInfoKHR

Valid Usage

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

• If handleType is not EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_BIT or EXTERNAL_SEMAPHORE_HANDLE_TYPE_D3D12_FENCE_BIT, name must be NULL
• If handleType is not 0 and handle is NULL, name must name a valid synchronization primitive of the type specified by handleType
• If handleType is not 0 and name is NULL, handle must be a valid handle of the type specified by handleType
• If handle is not NULL, name must be NULL
• If handle is not NULL, it must obey any requirements listed for handleType in external semaphore handle types compatibility
• If name is not NULL, it must obey any requirements listed for handleType in external semaphore handle types compatibility
• If handleType is EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_BIT or EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT, the SemaphoreCreateInfo::flags field must match that of the semaphore from which handle or name was exported
• If handleType is EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_BIT or EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT, the SemaphoreTypeCreateInfo::semaphoreType field must match that of the semaphore from which handle or name was exported
• If flags contains SEMAPHORE_IMPORT_TEMPORARY_BIT, the SemaphoreTypeCreateInfo::semaphoreType field of the semaphore from which handle or name was exported must not be SEMAPHORE_TYPE_TIMELINE

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_IMPORT_SEMAPHORE_WIN32_HANDLE_INFO_KHR

• pNext must be NULL
• semaphore must be a valid Semaphore handle
• flags must be a valid combination of SemaphoreImportFlagBits values
• If handleType is not 0, handleType must be a valid ExternalSemaphoreHandleTypeFlagBits value

Host Synchronization

• Host access to semaphore must be externally synchronized

See Also

ExternalSemaphoreHandleTypeFlagBits, Semaphore, SemaphoreImportFlags, StructureType, importSemaphoreWin32HandleKHR

Constructors

ImportSemaphoreWin32HandleInfoKHR

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 specifies the type of handle.

• handle :: HANDLE

  handle is the external handle to import, or NULL.

• name :: LPCWSTR

  name is a null-terminated UTF-16 string naming the underlying synchronization primitive to import, or NULL.

Instances

Eq ImportSemaphoreWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_semaphore_win32

Methods

(==) :: ImportSemaphoreWin32HandleInfoKHR -> ImportSemaphoreWin32HandleInfoKHR -> Bool

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

Show ImportSemaphoreWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_semaphore_win32

Methods

showsPrec :: Int -> ImportSemaphoreWin32HandleInfoKHR -> ShowS

show :: ImportSemaphoreWin32HandleInfoKHR -> String

showList :: [ImportSemaphoreWin32HandleInfoKHR] -> ShowS

Generic ImportSemaphoreWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_semaphore_win32

Associated Types

type Rep ImportSemaphoreWin32HandleInfoKHR :: Type -> Type

Methods

from :: ImportSemaphoreWin32HandleInfoKHR -> Rep ImportSemaphoreWin32HandleInfoKHR x

to :: Rep ImportSemaphoreWin32HandleInfoKHR x -> ImportSemaphoreWin32HandleInfoKHR

Storable ImportSemaphoreWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_semaphore_win32

Methods

sizeOf :: ImportSemaphoreWin32HandleInfoKHR -> Int

alignment :: ImportSemaphoreWin32HandleInfoKHR -> Int

peekElemOff :: Ptr ImportSemaphoreWin32HandleInfoKHR -> Int -> IO ImportSemaphoreWin32HandleInfoKHR

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

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

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

peek :: Ptr ImportSemaphoreWin32HandleInfoKHR -> IO ImportSemaphoreWin32HandleInfoKHR

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

FromCStruct ImportSemaphoreWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_semaphore_win32

Methods

peekCStruct :: Ptr ImportSemaphoreWin32HandleInfoKHR -> IO ImportSemaphoreWin32HandleInfoKHR

ToCStruct ImportSemaphoreWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_semaphore_win32

Methods

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

pokeCStruct :: Ptr ImportSemaphoreWin32HandleInfoKHR -> ImportSemaphoreWin32HandleInfoKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr ImportSemaphoreWin32HandleInfoKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero ImportSemaphoreWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_semaphore_win32

Methods

zero :: ImportSemaphoreWin32HandleInfoKHR

type Rep ImportSemaphoreWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_semaphore_win32

type Rep ImportSemaphoreWin32HandleInfoKHR = D1 ('MetaData "ImportSemaphoreWin32HandleInfoKHR" "Vulkan.Extensions.VK_KHR_external_semaphore_win32" "vulkan-3.6.3-inplace" 'False) (C1 ('MetaCons "ImportSemaphoreWin32HandleInfoKHR" 'PrefixI 'True) ((S1 ('MetaSel ('Just "semaphore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Semaphore) :*: S1 ('MetaSel ('Just "flags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SemaphoreImportFlags)) :*: (S1 ('MetaSel ('Just "handleType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ExternalSemaphoreHandleTypeFlagBits) :*: (S1 ('MetaSel ('Just "handle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HANDLE) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LPCWSTR)))))

data ExportSemaphoreWin32HandleInfoKHR

VkExportSemaphoreWin32HandleInfoKHR - Structure specifying additional attributes of Windows handles exported from a semaphore

Description

If ExportSemaphoreCreateInfo is not present in the same pNext chain, this structure is ignored.

If ExportSemaphoreCreateInfo is present in the pNext chain of SemaphoreCreateInfo with a Windows handleType, but either ExportSemaphoreWin32HandleInfoKHR is not present in the pNext chain, or if it is but pAttributes is set to NULL, default security descriptor values will be used, and child processes created by the application will not inherit the handle, as described in the MSDN documentation for “Synchronization Object Security and Access Rights”1. Further, if the structure is not present, the access rights used depend on the handle type.

For handles of the following types:

EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_BIT

The implementation must ensure the access rights allow both signal and wait operations on the semaphore.

For handles of the following types:

EXTERNAL_SEMAPHORE_HANDLE_TYPE_D3D12_FENCE_BIT

The access rights must be:

GENERIC_ALL

1

https://docs.microsoft.com/en-us/windows/win32/sync/synchronization-object-security-and-access-rights

Valid Usage

• If ExportSemaphoreCreateInfo::handleTypes does not include EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_BIT or EXTERNAL_SEMAPHORE_HANDLE_TYPE_D3D12_FENCE_BIT, ExportSemaphoreWin32HandleInfoKHR must not be included in the pNext chain of SemaphoreCreateInfo

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_EXPORT_SEMAPHORE_WIN32_HANDLE_INFO_KHR

• If pAttributes is not NULL, pAttributes must be a valid pointer to a valid SECURITY_ATTRIBUTES value

See Also

StructureType

Constructors

ExportSemaphoreWin32HandleInfoKHR

Fields

• attributes :: Ptr SECURITY_ATTRIBUTES

  pAttributes is a pointer to a Windows SECURITY_ATTRIBUTES structure specifying security attributes of the handle.

• dwAccess :: DWORD

  dwAccess is a DWORD specifying access rights of the handle.

• name :: LPCWSTR

  name is a null-terminated UTF-16 string to associate with the underlying synchronization primitive referenced by NT handles exported from the created semaphore.

Instances

Eq ExportSemaphoreWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_semaphore_win32

Methods

(==) :: ExportSemaphoreWin32HandleInfoKHR -> ExportSemaphoreWin32HandleInfoKHR -> Bool

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

Show ExportSemaphoreWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_semaphore_win32

Methods

showsPrec :: Int -> ExportSemaphoreWin32HandleInfoKHR -> ShowS

show :: ExportSemaphoreWin32HandleInfoKHR -> String

showList :: [ExportSemaphoreWin32HandleInfoKHR] -> ShowS

Generic ExportSemaphoreWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_semaphore_win32

Associated Types

type Rep ExportSemaphoreWin32HandleInfoKHR :: Type -> Type

Methods

from :: ExportSemaphoreWin32HandleInfoKHR -> Rep ExportSemaphoreWin32HandleInfoKHR x

to :: Rep ExportSemaphoreWin32HandleInfoKHR x -> ExportSemaphoreWin32HandleInfoKHR

Storable ExportSemaphoreWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_semaphore_win32

Methods

sizeOf :: ExportSemaphoreWin32HandleInfoKHR -> Int

alignment :: ExportSemaphoreWin32HandleInfoKHR -> Int

peekElemOff :: Ptr ExportSemaphoreWin32HandleInfoKHR -> Int -> IO ExportSemaphoreWin32HandleInfoKHR

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

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

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

peek :: Ptr ExportSemaphoreWin32HandleInfoKHR -> IO ExportSemaphoreWin32HandleInfoKHR

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

FromCStruct ExportSemaphoreWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_semaphore_win32

Methods

peekCStruct :: Ptr ExportSemaphoreWin32HandleInfoKHR -> IO ExportSemaphoreWin32HandleInfoKHR

ToCStruct ExportSemaphoreWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_semaphore_win32

Methods

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

pokeCStruct :: Ptr ExportSemaphoreWin32HandleInfoKHR -> ExportSemaphoreWin32HandleInfoKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr ExportSemaphoreWin32HandleInfoKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero ExportSemaphoreWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_semaphore_win32

Methods

zero :: ExportSemaphoreWin32HandleInfoKHR

type Rep ExportSemaphoreWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_semaphore_win32

type Rep ExportSemaphoreWin32HandleInfoKHR = D1 ('MetaData "ExportSemaphoreWin32HandleInfoKHR" "Vulkan.Extensions.VK_KHR_external_semaphore_win32" "vulkan-3.6.3-inplace" 'False) (C1 ('MetaCons "ExportSemaphoreWin32HandleInfoKHR" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Ptr SECURITY_ATTRIBUTES)) :*: (S1 ('MetaSel ('Just "dwAccess") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DWORD) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LPCWSTR))))

data D3D12FenceSubmitInfoKHR

VkD3D12FenceSubmitInfoKHR - Structure specifying values for Direct3D 12 fence-backed semaphores

Description

If the semaphore in SubmitInfo::pWaitSemaphores or SubmitInfo::pSignalSemaphores corresponding to an entry in pWaitSemaphoreValues or pSignalSemaphoreValues respectively does not currently have a payload referring to a Direct3D 12 fence, the implementation must ignore the value in the pWaitSemaphoreValues or pSignalSemaphoreValues entry.

Note

As the introduction of the external semaphore handle type EXTERNAL_SEMAPHORE_HANDLE_TYPE_D3D12_FENCE_BIT predates that of timeline semaphores, support for importing semaphore payloads from external handles of that type into semaphores created (implicitly or explicitly) with a SemaphoreType of SEMAPHORE_TYPE_BINARY is preserved for backwards compatibility. However, applications should prefer importing such handle types into semaphores created with a SemaphoreType of SEMAPHORE_TYPE_TIMELINE, and use the TimelineSemaphoreSubmitInfo structure instead of the D3D12FenceSubmitInfoKHR structure to specify the values to use when waiting for and signaling such semaphores.

Valid Usage

• waitSemaphoreValuesCount must be the same value as SubmitInfo::waitSemaphoreCount, where SubmitInfo is in the pNext chain of this D3D12FenceSubmitInfoKHR structure

• signalSemaphoreValuesCount must be the same value as SubmitInfo::signalSemaphoreCount, where SubmitInfo is in the pNext chain of this D3D12FenceSubmitInfoKHR structure

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_D3D12_FENCE_SUBMIT_INFO_KHR

• If waitSemaphoreValuesCount is not 0, and pWaitSemaphoreValues is not NULL, pWaitSemaphoreValues must be a valid pointer to an array of waitSemaphoreValuesCount uint64_t values
• If signalSemaphoreValuesCount is not 0, and pSignalSemaphoreValues is not NULL, pSignalSemaphoreValues must be a valid pointer to an array of signalSemaphoreValuesCount uint64_t values

See Also

StructureType

Constructors

D3D12FenceSubmitInfoKHR

Fields

• waitSemaphoreValuesCount :: Word32

  waitSemaphoreValuesCount is the number of semaphore wait values specified in pWaitSemaphoreValues.

• waitSemaphoreValues :: Vector Word64

  pWaitSemaphoreValues is a pointer to an array of waitSemaphoreValuesCount values for the corresponding semaphores in SubmitInfo::pWaitSemaphores to wait for.

• signalSemaphoreValuesCount :: Word32

  signalSemaphoreValuesCount is the number of semaphore signal values specified in pSignalSemaphoreValues.

• signalSemaphoreValues :: Vector Word64

  pSignalSemaphoreValues is a pointer to an array of signalSemaphoreValuesCount values for the corresponding semaphores in SubmitInfo::pSignalSemaphores to set when signaled.

Instances

Show D3D12FenceSubmitInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_semaphore_win32

Methods

showsPrec :: Int -> D3D12FenceSubmitInfoKHR -> ShowS

show :: D3D12FenceSubmitInfoKHR -> String

showList :: [D3D12FenceSubmitInfoKHR] -> ShowS

Generic D3D12FenceSubmitInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_semaphore_win32

Associated Types

type Rep D3D12FenceSubmitInfoKHR :: Type -> Type

Methods

from :: D3D12FenceSubmitInfoKHR -> Rep D3D12FenceSubmitInfoKHR x

to :: Rep D3D12FenceSubmitInfoKHR x -> D3D12FenceSubmitInfoKHR

FromCStruct D3D12FenceSubmitInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_semaphore_win32

Methods

peekCStruct :: Ptr D3D12FenceSubmitInfoKHR -> IO D3D12FenceSubmitInfoKHR

ToCStruct D3D12FenceSubmitInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_semaphore_win32

Methods

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

pokeCStruct :: Ptr D3D12FenceSubmitInfoKHR -> D3D12FenceSubmitInfoKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr D3D12FenceSubmitInfoKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero D3D12FenceSubmitInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_semaphore_win32

Methods

zero :: D3D12FenceSubmitInfoKHR

type Rep D3D12FenceSubmitInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_semaphore_win32

type Rep D3D12FenceSubmitInfoKHR = D1 ('MetaData "D3D12FenceSubmitInfoKHR" "Vulkan.Extensions.VK_KHR_external_semaphore_win32" "vulkan-3.6.3-inplace" 'False) (C1 ('MetaCons "D3D12FenceSubmitInfoKHR" 'PrefixI 'True) ((S1 ('MetaSel ('Just "waitSemaphoreValuesCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :*: S1 ('MetaSel ('Just "waitSemaphoreValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Vector Word64))) :*: (S1 ('MetaSel ('Just "signalSemaphoreValuesCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :*: S1 ('MetaSel ('Just "signalSemaphoreValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Vector Word64)))))

data SemaphoreGetWin32HandleInfoKHR

VkSemaphoreGetWin32HandleInfoKHR - Structure describing a Win32 handle semaphore export operation

Description

The properties of the 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 the semaphore’s current payload was created

• If handleType is defined as an NT handle, getSemaphoreWin32HandleKHR must be called no more than once for each valid unique combination of semaphore and handleType
• 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 an NT handle or a global share handle

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_SEMAPHORE_GET_WIN32_HANDLE_INFO_KHR

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

See Also

ExternalSemaphoreHandleTypeFlagBits, Semaphore, StructureType, getSemaphoreWin32HandleKHR

Constructors

SemaphoreGetWin32HandleInfoKHR

Fields

• semaphore :: Semaphore

  semaphore is the semaphore from which state will be exported.

• handleType :: ExternalSemaphoreHandleTypeFlagBits

  handleType is the type of handle requested.

Instances

Eq SemaphoreGetWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_semaphore_win32

Methods

(==) :: SemaphoreGetWin32HandleInfoKHR -> SemaphoreGetWin32HandleInfoKHR -> Bool

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

Show SemaphoreGetWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_semaphore_win32

Methods

showsPrec :: Int -> SemaphoreGetWin32HandleInfoKHR -> ShowS

show :: SemaphoreGetWin32HandleInfoKHR -> String

showList :: [SemaphoreGetWin32HandleInfoKHR] -> ShowS

Generic SemaphoreGetWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_semaphore_win32

Associated Types

type Rep SemaphoreGetWin32HandleInfoKHR :: Type -> Type

Methods

from :: SemaphoreGetWin32HandleInfoKHR -> Rep SemaphoreGetWin32HandleInfoKHR x

to :: Rep SemaphoreGetWin32HandleInfoKHR x -> SemaphoreGetWin32HandleInfoKHR

Storable SemaphoreGetWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_semaphore_win32

Methods

sizeOf :: SemaphoreGetWin32HandleInfoKHR -> Int

alignment :: SemaphoreGetWin32HandleInfoKHR -> Int

peekElemOff :: Ptr SemaphoreGetWin32HandleInfoKHR -> Int -> IO SemaphoreGetWin32HandleInfoKHR

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

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

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

peek :: Ptr SemaphoreGetWin32HandleInfoKHR -> IO SemaphoreGetWin32HandleInfoKHR

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

FromCStruct SemaphoreGetWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_semaphore_win32

Methods

peekCStruct :: Ptr SemaphoreGetWin32HandleInfoKHR -> IO SemaphoreGetWin32HandleInfoKHR

ToCStruct SemaphoreGetWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_semaphore_win32

Methods

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

pokeCStruct :: Ptr SemaphoreGetWin32HandleInfoKHR -> SemaphoreGetWin32HandleInfoKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr SemaphoreGetWin32HandleInfoKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero SemaphoreGetWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_semaphore_win32

Methods

zero :: SemaphoreGetWin32HandleInfoKHR

type Rep SemaphoreGetWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_semaphore_win32

type Rep SemaphoreGetWin32HandleInfoKHR = D1 ('MetaData "SemaphoreGetWin32HandleInfoKHR" "Vulkan.Extensions.VK_KHR_external_semaphore_win32" "vulkan-3.6.3-inplace" 'False) (C1 ('MetaCons "SemaphoreGetWin32HandleInfoKHR" 'PrefixI 'True) (S1 ('MetaSel ('Just "semaphore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Semaphore) :*: S1 ('MetaSel ('Just "handleType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ExternalSemaphoreHandleTypeFlagBits)))

type KHR_EXTERNAL_SEMAPHORE_WIN32_SPEC_VERSION = 1

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

type KHR_EXTERNAL_SEMAPHORE_WIN32_EXTENSION_NAME = "VK_KHR_external_semaphore_win32"

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

type HANDLE = Ptr ()

type DWORD = Word32

type LPCWSTR = Ptr CWchar

data SECURITY_ATTRIBUTES