Safe Haskell	None
Language	Haskell2010

Vulkan.Extensions.VK_NV_external_memory_win32

Synopsis

getMemoryWin32HandleNV :: forall io. MonadIO io => Device -> DeviceMemory -> ExternalMemoryHandleTypeFlagsNV -> io HANDLE
data ImportMemoryWin32HandleInfoNV = ImportMemoryWin32HandleInfoNV {
- handleType :: ExternalMemoryHandleTypeFlagsNV
- handle :: HANDLE
}
data ExportMemoryWin32HandleInfoNV = ExportMemoryWin32HandleInfoNV {
- attributes :: Ptr SECURITY_ATTRIBUTES
- dwAccess :: DWORD
}
type NV_EXTERNAL_MEMORY_WIN32_SPEC_VERSION = 1
pattern NV_EXTERNAL_MEMORY_WIN32_SPEC_VERSION :: forall a. Integral a => a
type NV_EXTERNAL_MEMORY_WIN32_EXTENSION_NAME = "VK_NV_external_memory_win32"
pattern NV_EXTERNAL_MEMORY_WIN32_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a
type HANDLE = Ptr ()
type DWORD = Word32
data SECURITY_ATTRIBUTES
newtype ExternalMemoryHandleTypeFlagBitsNV where
type ExternalMemoryHandleTypeFlagsNV = ExternalMemoryHandleTypeFlagBitsNV

Documentation

getMemoryWin32HandleNV Source #

Arguments

:: forall io. MonadIO io
=> Device	`device` is the logical device that owns the memory. `device` must be a valid `Device` handle
-> DeviceMemory	`memory` is the `DeviceMemory` object. `memory` must be a valid `DeviceMemory` handle `memory` must have been created, allocated, or retrieved from `device`
-> ExternalMemoryHandleTypeFlagsNV	`handleType` is a bitmask of `ExternalMemoryHandleTypeFlagBitsNV` containing a single bit specifying the type of handle requested. `handleType` must be a flag specified in `ExportMemoryAllocateInfoNV`::`handleTypes` when allocating `memory` `handleType` must be a valid combination of `ExternalMemoryHandleTypeFlagBitsNV` values `handleType` must not be `0`
-> io HANDLE

vkGetMemoryWin32HandleNV - retrieve Win32 handle to a device memory object

Return Codes

Success

SUCCESS

Failure

Description

If handleType is 0, this structure is ignored by consumers of the MemoryAllocateInfo structure it is chained from.

Valid Usage (Implicit)

handleType :: ExternalMemoryHandleTypeFlagsNV
handleType is 0 or a ExternalMemoryHandleTypeFlagBitsNV value specifying the type of memory handle in handle.
handleType must not have more than one bit set
handleType must be a valid combination of ExternalMemoryHandleTypeFlagBitsNV values
handle :: HANDLE
handle is a Windows HANDLE referring to the memory.
handle must be a valid handle to memory, obtained as specified by handleType

Instances

Instances details

Eq ImportMemoryWin32HandleInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_memory_win32 Methods (==) :: ImportMemoryWin32HandleInfoNV -> ImportMemoryWin32HandleInfoNV -> Bool # (/=) :: ImportMemoryWin32HandleInfoNV -> ImportMemoryWin32HandleInfoNV -> Bool #
Show ImportMemoryWin32HandleInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_memory_win32 Methods showsPrec :: Int -> ImportMemoryWin32HandleInfoNV -> ShowS # show :: ImportMemoryWin32HandleInfoNV -> String # showList :: [ImportMemoryWin32HandleInfoNV] -> ShowS #
Generic ImportMemoryWin32HandleInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_memory_win32 Associated Types type Rep ImportMemoryWin32HandleInfoNV :: Type -> Type # Methods from :: ImportMemoryWin32HandleInfoNV -> Rep ImportMemoryWin32HandleInfoNV x # to :: Rep ImportMemoryWin32HandleInfoNV x -> ImportMemoryWin32HandleInfoNV #
Storable ImportMemoryWin32HandleInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_memory_win32 Methods sizeOf :: ImportMemoryWin32HandleInfoNV -> Int # alignment :: ImportMemoryWin32HandleInfoNV -> Int # peekElemOff :: Ptr ImportMemoryWin32HandleInfoNV -> Int -> IO ImportMemoryWin32HandleInfoNV # pokeElemOff :: Ptr ImportMemoryWin32HandleInfoNV -> Int -> ImportMemoryWin32HandleInfoNV -> IO () # peekByteOff :: Ptr b -> Int -> IO ImportMemoryWin32HandleInfoNV # pokeByteOff :: Ptr b -> Int -> ImportMemoryWin32HandleInfoNV -> IO () # peek :: Ptr ImportMemoryWin32HandleInfoNV -> IO ImportMemoryWin32HandleInfoNV # poke :: Ptr ImportMemoryWin32HandleInfoNV -> ImportMemoryWin32HandleInfoNV -> IO () #
FromCStruct ImportMemoryWin32HandleInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_memory_win32 Methods peekCStruct :: Ptr ImportMemoryWin32HandleInfoNV -> IO ImportMemoryWin32HandleInfoNV Source #
ToCStruct ImportMemoryWin32HandleInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_memory_win32 Methods withCStruct :: ImportMemoryWin32HandleInfoNV -> (Ptr ImportMemoryWin32HandleInfoNV -> IO b) -> IO b Source # pokeCStruct :: Ptr ImportMemoryWin32HandleInfoNV -> ImportMemoryWin32HandleInfoNV -> IO b -> IO b Source # withZeroCStruct :: (Ptr ImportMemoryWin32HandleInfoNV -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr ImportMemoryWin32HandleInfoNV -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero ImportMemoryWin32HandleInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_memory_win32 Methods zero :: ImportMemoryWin32HandleInfoNV Source #
type Rep ImportMemoryWin32HandleInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_memory_win32 type Rep ImportMemoryWin32HandleInfoNV = D1 ('MetaData "ImportMemoryWin32HandleInfoNV" "Vulkan.Extensions.VK_NV_external_memory_win32" "vulkan-3.6.1-inplace" 'False) (C1 ('MetaCons "ImportMemoryWin32HandleInfoNV" 'PrefixI 'True) (S1 ('MetaSel ('Just "handleType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ExternalMemoryHandleTypeFlagsNV) :*: S1 ('MetaSel ('Just "handle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HANDLE)))

data ExportMemoryWin32HandleInfoNV Source #

VkExportMemoryWin32HandleInfoNV - specify security attributes and access rights for Win32 memory handles

Description

If this structure is not present, or if 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 will be

DXGI_SHARED_RESOURCE_READ | DXGI_SHARED_RESOURCE_WRITE

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

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_EXPORT_MEMORY_WIN32_HANDLE_INFO_NV

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

Eq ExportMemoryWin32HandleInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_memory_win32 Methods (==) :: ExportMemoryWin32HandleInfoNV -> ExportMemoryWin32HandleInfoNV -> Bool # (/=) :: ExportMemoryWin32HandleInfoNV -> ExportMemoryWin32HandleInfoNV -> Bool #
Show ExportMemoryWin32HandleInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_memory_win32 Methods showsPrec :: Int -> ExportMemoryWin32HandleInfoNV -> ShowS # show :: ExportMemoryWin32HandleInfoNV -> String # showList :: [ExportMemoryWin32HandleInfoNV] -> ShowS #
Generic ExportMemoryWin32HandleInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_memory_win32 Associated Types type Rep ExportMemoryWin32HandleInfoNV :: Type -> Type # Methods from :: ExportMemoryWin32HandleInfoNV -> Rep ExportMemoryWin32HandleInfoNV x # to :: Rep ExportMemoryWin32HandleInfoNV x -> ExportMemoryWin32HandleInfoNV #
Storable ExportMemoryWin32HandleInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_memory_win32 Methods sizeOf :: ExportMemoryWin32HandleInfoNV -> Int # alignment :: ExportMemoryWin32HandleInfoNV -> Int # peekElemOff :: Ptr ExportMemoryWin32HandleInfoNV -> Int -> IO ExportMemoryWin32HandleInfoNV # pokeElemOff :: Ptr ExportMemoryWin32HandleInfoNV -> Int -> ExportMemoryWin32HandleInfoNV -> IO () # peekByteOff :: Ptr b -> Int -> IO ExportMemoryWin32HandleInfoNV # pokeByteOff :: Ptr b -> Int -> ExportMemoryWin32HandleInfoNV -> IO () # peek :: Ptr ExportMemoryWin32HandleInfoNV -> IO ExportMemoryWin32HandleInfoNV # poke :: Ptr ExportMemoryWin32HandleInfoNV -> ExportMemoryWin32HandleInfoNV -> IO () #
FromCStruct ExportMemoryWin32HandleInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_memory_win32 Methods peekCStruct :: Ptr ExportMemoryWin32HandleInfoNV -> IO ExportMemoryWin32HandleInfoNV Source #
ToCStruct ExportMemoryWin32HandleInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_memory_win32 Methods withCStruct :: ExportMemoryWin32HandleInfoNV -> (Ptr ExportMemoryWin32HandleInfoNV -> IO b) -> IO b Source # pokeCStruct :: Ptr ExportMemoryWin32HandleInfoNV -> ExportMemoryWin32HandleInfoNV -> IO b -> IO b Source # withZeroCStruct :: (Ptr ExportMemoryWin32HandleInfoNV -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr ExportMemoryWin32HandleInfoNV -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero ExportMemoryWin32HandleInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_memory_win32 Methods zero :: ExportMemoryWin32HandleInfoNV Source #
type Rep ExportMemoryWin32HandleInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_memory_win32 type Rep ExportMemoryWin32HandleInfoNV = D1 ('MetaData "ExportMemoryWin32HandleInfoNV" "Vulkan.Extensions.VK_NV_external_memory_win32" "vulkan-3.6.1-inplace" 'False) (C1 ('MetaCons "ExportMemoryWin32HandleInfoNV" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Ptr SECURITY_ATTRIBUTES)) :*: S1 ('MetaSel ('Just "dwAccess") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DWORD)))

type NV_EXTERNAL_MEMORY_WIN32_SPEC_VERSION = 1 Source #

pattern NV_EXTERNAL_MEMORY_WIN32_SPEC_VERSION :: forall a. Integral a => a Source #

type NV_EXTERNAL_MEMORY_WIN32_EXTENSION_NAME = "VK_NV_external_memory_win32" Source #

pattern NV_EXTERNAL_MEMORY_WIN32_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a Source #

type HANDLE = Ptr () Source #

type DWORD = Word32 Source #

data SECURITY_ATTRIBUTES Source #

newtype ExternalMemoryHandleTypeFlagBitsNV Source #

VkExternalMemoryHandleTypeFlagBitsNV - Bitmask specifying external memory handle types

pattern EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT_NV :: ExternalMemoryHandleTypeFlagBitsNV	`EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT_NV` specifies a handle to memory returned by `getMemoryWin32HandleNV`, or one duplicated from such a handle using `DuplicateHandle()`.
pattern EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT_NV :: ExternalMemoryHandleTypeFlagBitsNV	`EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT_NV` specifies a handle to memory returned by `getMemoryWin32HandleNV`.
pattern EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_IMAGE_BIT_NV :: ExternalMemoryHandleTypeFlagBitsNV	`EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_IMAGE_BIT_NV` specifies a valid NT handle to memory returned by `IDXGIResource1::CreateSharedHandle`, or a handle duplicated from such a handle using `DuplicateHandle()`.
pattern EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_IMAGE_KMT_BIT_NV :: ExternalMemoryHandleTypeFlagBitsNV	`EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_IMAGE_KMT_BIT_NV` specifies a handle to memory returned by `IDXGIResource::GetSharedHandle()`.

Instances

Instances details

Eq ExternalMemoryHandleTypeFlagBitsNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_memory_capabilities Methods (==) :: ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV -> Bool # (/=) :: ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV -> Bool #
Ord ExternalMemoryHandleTypeFlagBitsNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_memory_capabilities Methods compare :: ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV -> Ordering # (<) :: ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV -> Bool # (<=) :: ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV -> Bool # (>) :: ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV -> Bool # (>=) :: ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV -> Bool # max :: ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV # min :: ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV #
Read ExternalMemoryHandleTypeFlagBitsNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_memory_capabilities Methods readsPrec :: Int -> ReadS ExternalMemoryHandleTypeFlagBitsNV # readList :: ReadS [ExternalMemoryHandleTypeFlagBitsNV] # readPrec :: ReadPrec ExternalMemoryHandleTypeFlagBitsNV # readListPrec :: ReadPrec [ExternalMemoryHandleTypeFlagBitsNV] #
Show ExternalMemoryHandleTypeFlagBitsNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_memory_capabilities Methods showsPrec :: Int -> ExternalMemoryHandleTypeFlagBitsNV -> ShowS # show :: ExternalMemoryHandleTypeFlagBitsNV -> String # showList :: [ExternalMemoryHandleTypeFlagBitsNV] -> ShowS #
Storable ExternalMemoryHandleTypeFlagBitsNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_memory_capabilities Methods sizeOf :: ExternalMemoryHandleTypeFlagBitsNV -> Int # alignment :: ExternalMemoryHandleTypeFlagBitsNV -> Int # peekElemOff :: Ptr ExternalMemoryHandleTypeFlagBitsNV -> Int -> IO ExternalMemoryHandleTypeFlagBitsNV # pokeElemOff :: Ptr ExternalMemoryHandleTypeFlagBitsNV -> Int -> ExternalMemoryHandleTypeFlagBitsNV -> IO () # peekByteOff :: Ptr b -> Int -> IO ExternalMemoryHandleTypeFlagBitsNV # pokeByteOff :: Ptr b -> Int -> ExternalMemoryHandleTypeFlagBitsNV -> IO () # peek :: Ptr ExternalMemoryHandleTypeFlagBitsNV -> IO ExternalMemoryHandleTypeFlagBitsNV # poke :: Ptr ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV -> IO () #
Bits ExternalMemoryHandleTypeFlagBitsNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_memory_capabilities Methods (.&.) :: ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV # (.\|.) :: ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV # xor :: ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV # complement :: ExternalMemoryHandleTypeFlagBitsNV -> ExternalMemoryHandleTypeFlagBitsNV # shift :: ExternalMemoryHandleTypeFlagBitsNV -> Int -> ExternalMemoryHandleTypeFlagBitsNV # rotate :: ExternalMemoryHandleTypeFlagBitsNV -> Int -> ExternalMemoryHandleTypeFlagBitsNV # zeroBits :: ExternalMemoryHandleTypeFlagBitsNV # bit :: Int -> ExternalMemoryHandleTypeFlagBitsNV # setBit :: ExternalMemoryHandleTypeFlagBitsNV -> Int -> ExternalMemoryHandleTypeFlagBitsNV # clearBit :: ExternalMemoryHandleTypeFlagBitsNV -> Int -> ExternalMemoryHandleTypeFlagBitsNV # complementBit :: ExternalMemoryHandleTypeFlagBitsNV -> Int -> ExternalMemoryHandleTypeFlagBitsNV # testBit :: ExternalMemoryHandleTypeFlagBitsNV -> Int -> Bool # bitSizeMaybe :: ExternalMemoryHandleTypeFlagBitsNV -> Maybe Int # bitSize :: ExternalMemoryHandleTypeFlagBitsNV -> Int # isSigned :: ExternalMemoryHandleTypeFlagBitsNV -> Bool # shiftL :: ExternalMemoryHandleTypeFlagBitsNV -> Int -> ExternalMemoryHandleTypeFlagBitsNV # unsafeShiftL :: ExternalMemoryHandleTypeFlagBitsNV -> Int -> ExternalMemoryHandleTypeFlagBitsNV # shiftR :: ExternalMemoryHandleTypeFlagBitsNV -> Int -> ExternalMemoryHandleTypeFlagBitsNV # unsafeShiftR :: ExternalMemoryHandleTypeFlagBitsNV -> Int -> ExternalMemoryHandleTypeFlagBitsNV # rotateL :: ExternalMemoryHandleTypeFlagBitsNV -> Int -> ExternalMemoryHandleTypeFlagBitsNV # rotateR :: ExternalMemoryHandleTypeFlagBitsNV -> Int -> ExternalMemoryHandleTypeFlagBitsNV # popCount :: ExternalMemoryHandleTypeFlagBitsNV -> Int #
Zero ExternalMemoryHandleTypeFlagBitsNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_memory_capabilities Methods zero :: ExternalMemoryHandleTypeFlagBitsNV Source #

type ExternalMemoryHandleTypeFlagsNV = ExternalMemoryHandleTypeFlagBitsNV Source #

Documentation

Return Codes

See Also

Description

Valid Usage (Implicit)

See Also

Instances

Description

Valid Usage (Implicit)

See Also

Instances

See Also

Instances

ExportMemoryWin32HandleInfoNV
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.