vulkan-2.0.0.1: Bindings to the Vulkan graphics API.

Safe HaskellNone
LanguageHaskell2010

Graphics.Vulkan.Extensions.VK_KHR_win32_surface

Synopsis

Documentation

type HINSTANCE = Ptr () Source #

type HWND = Ptr () Source #

newtype VkWin32SurfaceCreateFlagsKHR Source #

Constructors

VkWin32SurfaceCreateFlagsKHR VkFlags 
Instances
Eq VkWin32SurfaceCreateFlagsKHR Source # 
Instance details

Methods

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

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

Ord VkWin32SurfaceCreateFlagsKHR Source # 
Instance details

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 Source # 
Instance details

Methods

readsPrec :: Int -> ReadS VkWin32SurfaceCreateFlagsKHR #

readList :: ReadS [VkWin32SurfaceCreateFlagsKHR] #

readPrec :: ReadPrec VkWin32SurfaceCreateFlagsKHR #

readListPrec :: ReadPrec [VkWin32SurfaceCreateFlagsKHR] #

Show VkWin32SurfaceCreateFlagsKHR Source # 
Instance details

Methods

showsPrec :: Int -> VkWin32SurfaceCreateFlagsKHR -> ShowS #

show :: VkWin32SurfaceCreateFlagsKHR -> String #

showList :: [VkWin32SurfaceCreateFlagsKHR] -> ShowS #

Storable VkWin32SurfaceCreateFlagsKHR Source # 
Instance details

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 Source # 
Instance details

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 Source # 
Instance details

Methods

finiteBitSize :: VkWin32SurfaceCreateFlagsKHR -> Int #

countLeadingZeros :: VkWin32SurfaceCreateFlagsKHR -> Int #

countTrailingZeros :: VkWin32SurfaceCreateFlagsKHR -> Int #

pattern VK_STRUCTURE_TYPE_WIN32_SURFACE_CREATE_INFO_KHR :: VkStructureType Source #

pattern VK_KHR_WIN32_SURFACE_SPEC_VERSION :: Integral a => a Source #

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

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

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 Source #

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 Source #

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

Instances
Eq VkWin32SurfaceCreateInfoKHR Source # 
Instance details

Methods

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

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

Show VkWin32SurfaceCreateInfoKHR Source # 
Instance details

Methods

showsPrec :: Int -> VkWin32SurfaceCreateInfoKHR -> ShowS #

show :: VkWin32SurfaceCreateInfoKHR -> String #

showList :: [VkWin32SurfaceCreateInfoKHR] -> ShowS #

Storable VkWin32SurfaceCreateInfoKHR Source # 
Instance details

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 () #