Graphics.Vulkan.Extensions.VK_KHR_win32_surface

Documentation

type HINSTANCE = Ptr ()

type HWND = Ptr ()

newtype VkWin32SurfaceCreateFlagsKHR

Constructors

VkWin32SurfaceCreateFlagsKHR VkFlags

Instances

Eq VkWin32SurfaceCreateFlagsKHR

Methods

(==) :: VkWin32SurfaceCreateFlagsKHR -> VkWin32SurfaceCreateFlagsKHR -> Bool

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

Ord VkWin32SurfaceCreateFlagsKHR

Methods

compare :: VkWin32SurfaceCreateFlagsKHR -> VkWin32SurfaceCreateFlagsKHR -> Ordering

(<) :: VkWin32SurfaceCreateFlagsKHR -> VkWin32SurfaceCreateFlagsKHR -> Bool

(<=) :: VkWin32SurfaceCreateFlagsKHR -> VkWin32SurfaceCreateFlagsKHR -> Bool

(>) :: VkWin32SurfaceCreateFlagsKHR -> VkWin32SurfaceCreateFlagsKHR -> Bool

(>=) :: VkWin32SurfaceCreateFlagsKHR -> VkWin32SurfaceCreateFlagsKHR -> Bool

max :: VkWin32SurfaceCreateFlagsKHR -> VkWin32SurfaceCreateFlagsKHR -> VkWin32SurfaceCreateFlagsKHR

min :: VkWin32SurfaceCreateFlagsKHR -> VkWin32SurfaceCreateFlagsKHR -> VkWin32SurfaceCreateFlagsKHR

Read VkWin32SurfaceCreateFlagsKHR

Methods

readsPrec :: Int -> ReadS VkWin32SurfaceCreateFlagsKHR

readList :: ReadS [VkWin32SurfaceCreateFlagsKHR]

readPrec :: ReadPrec VkWin32SurfaceCreateFlagsKHR

readListPrec :: ReadPrec [VkWin32SurfaceCreateFlagsKHR]

Show VkWin32SurfaceCreateFlagsKHR

Methods

showsPrec :: Int -> VkWin32SurfaceCreateFlagsKHR -> ShowS

show :: VkWin32SurfaceCreateFlagsKHR -> String

showList :: [VkWin32SurfaceCreateFlagsKHR] -> ShowS

Storable VkWin32SurfaceCreateFlagsKHR

Methods

sizeOf :: VkWin32SurfaceCreateFlagsKHR -> Int

alignment :: VkWin32SurfaceCreateFlagsKHR -> Int

peekElemOff :: Ptr VkWin32SurfaceCreateFlagsKHR -> Int -> IO VkWin32SurfaceCreateFlagsKHR

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

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

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

peek :: Ptr VkWin32SurfaceCreateFlagsKHR -> IO VkWin32SurfaceCreateFlagsKHR

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

Bits VkWin32SurfaceCreateFlagsKHR

Methods

(.&.) :: VkWin32SurfaceCreateFlagsKHR -> VkWin32SurfaceCreateFlagsKHR -> VkWin32SurfaceCreateFlagsKHR

(.|.) :: VkWin32SurfaceCreateFlagsKHR -> VkWin32SurfaceCreateFlagsKHR -> VkWin32SurfaceCreateFlagsKHR

xor :: VkWin32SurfaceCreateFlagsKHR -> VkWin32SurfaceCreateFlagsKHR -> VkWin32SurfaceCreateFlagsKHR

complement :: VkWin32SurfaceCreateFlagsKHR -> VkWin32SurfaceCreateFlagsKHR

shift :: VkWin32SurfaceCreateFlagsKHR -> Int -> VkWin32SurfaceCreateFlagsKHR

rotate :: VkWin32SurfaceCreateFlagsKHR -> Int -> VkWin32SurfaceCreateFlagsKHR

zeroBits :: VkWin32SurfaceCreateFlagsKHR

bit :: Int -> VkWin32SurfaceCreateFlagsKHR

setBit :: VkWin32SurfaceCreateFlagsKHR -> Int -> VkWin32SurfaceCreateFlagsKHR

clearBit :: VkWin32SurfaceCreateFlagsKHR -> Int -> VkWin32SurfaceCreateFlagsKHR

complementBit :: VkWin32SurfaceCreateFlagsKHR -> Int -> VkWin32SurfaceCreateFlagsKHR

testBit :: VkWin32SurfaceCreateFlagsKHR -> Int -> Bool

bitSizeMaybe :: VkWin32SurfaceCreateFlagsKHR -> Maybe Int

bitSize :: VkWin32SurfaceCreateFlagsKHR -> Int

isSigned :: VkWin32SurfaceCreateFlagsKHR -> Bool

shiftL :: VkWin32SurfaceCreateFlagsKHR -> Int -> VkWin32SurfaceCreateFlagsKHR

unsafeShiftL :: VkWin32SurfaceCreateFlagsKHR -> Int -> VkWin32SurfaceCreateFlagsKHR

shiftR :: VkWin32SurfaceCreateFlagsKHR -> Int -> VkWin32SurfaceCreateFlagsKHR

unsafeShiftR :: VkWin32SurfaceCreateFlagsKHR -> Int -> VkWin32SurfaceCreateFlagsKHR

rotateL :: VkWin32SurfaceCreateFlagsKHR -> Int -> VkWin32SurfaceCreateFlagsKHR

rotateR :: VkWin32SurfaceCreateFlagsKHR -> Int -> VkWin32SurfaceCreateFlagsKHR

popCount :: VkWin32SurfaceCreateFlagsKHR -> Int

FiniteBits VkWin32SurfaceCreateFlagsKHR

Methods

finiteBitSize :: VkWin32SurfaceCreateFlagsKHR -> Int

countLeadingZeros :: VkWin32SurfaceCreateFlagsKHR -> Int

countTrailingZeros :: VkWin32SurfaceCreateFlagsKHR -> Int

pattern VK_STRUCTURE_TYPE_WIN32_SURFACE_CREATE_INFO_KHR :: VkStructureType

pattern VK_KHR_WIN32_SURFACE_SPEC_VERSION :: Integral a => a

pattern VK_KHR_WIN32_SURFACE_EXTENSION_NAME :: (Eq a, IsString a) => a

vkCreateWin32SurfaceKHR :: ("instance" ::: VkInstance) -> ("pCreateInfo" ::: Ptr VkWin32SurfaceCreateInfoKHR) -> ("pAllocator" ::: Ptr VkAllocationCallbacks) -> ("pSurface" ::: Ptr VkSurfaceKHR) -> IO VkResult

vkCreateWin32SurfaceKHR - Create a VkSurfaceKHR object for an Win32 native window

Parameters

• instance is the instance to associate the surface with.

• pCreateInfo is a pointer to an instance of the VkWin32SurfaceCreateInfoKHR structure containing parameters affecting the creation of the surface object.
• pAllocator is the allocator used for host memory allocated for the surface object when there is no more specific allocator available (see Memory Allocation).
• pSurface points to a VkSurfaceKHR handle in which the created surface object is returned.

Valid Usage (Implicit)

• instance must be a valid VkInstance handle

• pCreateInfo must be a valid pointer to a valid VkWin32SurfaceCreateInfoKHR structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure
• pSurface must be a valid pointer to a VkSurfaceKHR handle

Return Codes

[Success] - VK_SUCCESS

[Failure] - VK_ERROR_OUT_OF_HOST_MEMORY

• VK_ERROR_OUT_OF_DEVICE_MEMORY

See Also

VkAllocationCallbacks, VkInstance, VkSurfaceKHR, VkWin32SurfaceCreateInfoKHR

vkGetPhysicalDeviceWin32PresentationSupportKHR :: ("physicalDevice" ::: VkPhysicalDevice) -> ("queueFamilyIndex" ::: Word32) -> IO VkBool32

vkGetPhysicalDeviceWin32PresentationSupportKHR - query queue family support for presentation on a Win32 display

Parameters

• physicalDevice is the physical device.

• queueFamilyIndex is the queue family index.

Description

This platform-specific function can be called prior to creating a surface.

Valid Usage

• queueFamilyIndex must be less than pQueueFamilyPropertyCount returned by vkGetPhysicalDeviceQueueFamilyProperties for the given physicalDevice

Valid Usage (Implicit)

• physicalDevice must be a valid VkPhysicalDevice handle

See Also

VkPhysicalDevice

data VkWin32SurfaceCreateInfoKHR

VkWin32SurfaceCreateInfoKHR - Structure specifying parameters of a newly created Win32 surface object

Valid Usage

• hinstance must be a valid Win32 HINSTANCE.

• hwnd must be a valid Win32 HWND.

Valid Usage (Implicit)

• sType must be VK_STRUCTURE_TYPE_WIN32_SURFACE_CREATE_INFO_KHR

• pNext must be NULL
• flags must be 0

See Also

VkStructureType, VkWin32SurfaceCreateFlagsKHR, vkCreateWin32SurfaceKHR

Constructors

VkWin32SurfaceCreateInfoKHR

Fields

• vkSType :: VkStructureType

  sType is the type of this structure.

• vkPNext :: Ptr ()

  pNext is NULL or a pointer to an extension-specific structure.

• vkFlags :: VkWin32SurfaceCreateFlagsKHR

  flags is reserved for future use.

• vkHinstance :: HINSTANCE

  hinstance and hwnd are the Win32 HINSTANCE and HWND for the window to associate the surface with.

• vkHwnd :: HWND

Instances

Eq VkWin32SurfaceCreateInfoKHR

Methods

(==) :: VkWin32SurfaceCreateInfoKHR -> VkWin32SurfaceCreateInfoKHR -> Bool

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

Show VkWin32SurfaceCreateInfoKHR

Methods

showsPrec :: Int -> VkWin32SurfaceCreateInfoKHR -> ShowS

show :: VkWin32SurfaceCreateInfoKHR -> String

showList :: [VkWin32SurfaceCreateInfoKHR] -> ShowS

Storable VkWin32SurfaceCreateInfoKHR

Methods

sizeOf :: VkWin32SurfaceCreateInfoKHR -> Int

alignment :: VkWin32SurfaceCreateInfoKHR -> Int

peekElemOff :: Ptr VkWin32SurfaceCreateInfoKHR -> Int -> IO VkWin32SurfaceCreateInfoKHR

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

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

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

peek :: Ptr VkWin32SurfaceCreateInfoKHR -> IO VkWin32SurfaceCreateInfoKHR

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