vulkan-3.6.3: Bindings to the Vulkan graphics API.
Safe HaskellNone
LanguageHaskell2010

Vulkan.Extensions.VK_KHR_win32_surface

Synopsis

Documentation

createWin32SurfaceKHR Source #

Arguments

:: forall io. MonadIO io 
=> Instance

instance is the instance to associate the surface with.

-> Win32SurfaceCreateInfoKHR

pCreateInfo is a pointer to a Win32SurfaceCreateInfoKHR structure containing parameters affecting the creation of the surface object.

-> ("allocator" ::: Maybe AllocationCallbacks)

pAllocator is the allocator used for host memory allocated for the surface object when there is no more specific allocator available (see Memory Allocation).

-> io SurfaceKHR 

vkCreateWin32SurfaceKHR - Create a SurfaceKHR object for an Win32 native window

Valid Usage (Implicit)

  • instance must be a valid Instance handle

Return Codes

Success
Failure

See Also

AllocationCallbacks, Instance, SurfaceKHR, Win32SurfaceCreateInfoKHR

getPhysicalDeviceWin32PresentationSupportKHR Source #

Arguments

:: forall io. MonadIO io 
=> PhysicalDevice

physicalDevice is the physical device.

physicalDevice must be a valid PhysicalDevice handle

-> ("queueFamilyIndex" ::: Word32)

queueFamilyIndex is the queue family index.

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

-> io Bool 

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

Description

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

Valid Usage (Implicit)

See Also

PhysicalDevice

data Win32SurfaceCreateInfoKHR Source #

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

Valid Usage (Implicit)

See Also

StructureType, Win32SurfaceCreateFlagsKHR, createWin32SurfaceKHR

Constructors

Win32SurfaceCreateInfoKHR 

Fields

Instances

Instances details
Eq Win32SurfaceCreateInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_win32_surface

Methods

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

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

Show Win32SurfaceCreateInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_win32_surface

Methods

showsPrec :: Int -> Win32SurfaceCreateInfoKHR -> ShowS #

show :: Win32SurfaceCreateInfoKHR -> String #

showList :: [Win32SurfaceCreateInfoKHR] -> ShowS #

Generic Win32SurfaceCreateInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_win32_surface

Associated Types

type Rep Win32SurfaceCreateInfoKHR :: Type -> Type #

Methods

from :: Win32SurfaceCreateInfoKHR -> Rep Win32SurfaceCreateInfoKHR x #

to :: Rep Win32SurfaceCreateInfoKHR x -> Win32SurfaceCreateInfoKHR #

Storable Win32SurfaceCreateInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_win32_surface

Methods

sizeOf :: Win32SurfaceCreateInfoKHR -> Int #

alignment :: Win32SurfaceCreateInfoKHR -> Int #

peekElemOff :: Ptr Win32SurfaceCreateInfoKHR -> Int -> IO Win32SurfaceCreateInfoKHR #

pokeElemOff :: Ptr Win32SurfaceCreateInfoKHR -> Int -> Win32SurfaceCreateInfoKHR -> IO () #

peekByteOff :: Ptr b -> Int -> IO Win32SurfaceCreateInfoKHR #

pokeByteOff :: Ptr b -> Int -> Win32SurfaceCreateInfoKHR -> IO () #

peek :: Ptr Win32SurfaceCreateInfoKHR -> IO Win32SurfaceCreateInfoKHR #

poke :: Ptr Win32SurfaceCreateInfoKHR -> Win32SurfaceCreateInfoKHR -> IO () #

FromCStruct Win32SurfaceCreateInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_win32_surface

Methods

peekCStruct :: Ptr Win32SurfaceCreateInfoKHR -> IO Win32SurfaceCreateInfoKHR Source #

ToCStruct Win32SurfaceCreateInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_win32_surface

Methods

withCStruct :: Win32SurfaceCreateInfoKHR -> (Ptr Win32SurfaceCreateInfoKHR -> IO b) -> IO b Source #

pokeCStruct :: Ptr Win32SurfaceCreateInfoKHR -> Win32SurfaceCreateInfoKHR -> IO b -> IO b Source #

withZeroCStruct :: (Ptr Win32SurfaceCreateInfoKHR -> IO b) -> IO b Source #

pokeZeroCStruct :: Ptr Win32SurfaceCreateInfoKHR -> IO b -> IO b Source #

cStructSize :: Int Source #

cStructAlignment :: Int Source #

Zero Win32SurfaceCreateInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_win32_surface

Methods

zero :: Win32SurfaceCreateInfoKHR Source #

type Rep Win32SurfaceCreateInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_win32_surface

type Rep Win32SurfaceCreateInfoKHR = D1 ('MetaData "Win32SurfaceCreateInfoKHR" "Vulkan.Extensions.VK_KHR_win32_surface" "vulkan-3.6.3-inplace" 'False) (C1 ('MetaCons "Win32SurfaceCreateInfoKHR" 'PrefixI 'True) (S1 ('MetaSel ('Just "flags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Win32SurfaceCreateFlagsKHR) :*: (S1 ('MetaSel ('Just "hinstance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HINSTANCE) :*: S1 ('MetaSel ('Just "hwnd") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HWND))))

newtype Win32SurfaceCreateFlagsKHR Source #

VkWin32SurfaceCreateFlagsKHR - Reserved for future use

Description

Win32SurfaceCreateFlagsKHR is a bitmask type for setting a mask, but is currently reserved for future use.

See Also

Win32SurfaceCreateInfoKHR

Constructors

Win32SurfaceCreateFlagsKHR Flags 

Instances

Instances details
Eq Win32SurfaceCreateFlagsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_win32_surface

Methods

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

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

Ord Win32SurfaceCreateFlagsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_win32_surface

Methods

compare :: Win32SurfaceCreateFlagsKHR -> Win32SurfaceCreateFlagsKHR -> Ordering #

(<) :: Win32SurfaceCreateFlagsKHR -> Win32SurfaceCreateFlagsKHR -> Bool #

(<=) :: Win32SurfaceCreateFlagsKHR -> Win32SurfaceCreateFlagsKHR -> Bool #

(>) :: Win32SurfaceCreateFlagsKHR -> Win32SurfaceCreateFlagsKHR -> Bool #

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

max :: Win32SurfaceCreateFlagsKHR -> Win32SurfaceCreateFlagsKHR -> Win32SurfaceCreateFlagsKHR #

min :: Win32SurfaceCreateFlagsKHR -> Win32SurfaceCreateFlagsKHR -> Win32SurfaceCreateFlagsKHR #

Read Win32SurfaceCreateFlagsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_win32_surface

Methods

readsPrec :: Int -> ReadS Win32SurfaceCreateFlagsKHR #

readList :: ReadS [Win32SurfaceCreateFlagsKHR] #

readPrec :: ReadPrec Win32SurfaceCreateFlagsKHR #

readListPrec :: ReadPrec [Win32SurfaceCreateFlagsKHR] #

Show Win32SurfaceCreateFlagsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_win32_surface

Methods

showsPrec :: Int -> Win32SurfaceCreateFlagsKHR -> ShowS #

show :: Win32SurfaceCreateFlagsKHR -> String #

showList :: [Win32SurfaceCreateFlagsKHR] -> ShowS #

Storable Win32SurfaceCreateFlagsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_win32_surface

Methods

sizeOf :: Win32SurfaceCreateFlagsKHR -> Int #

alignment :: Win32SurfaceCreateFlagsKHR -> Int #

peekElemOff :: Ptr Win32SurfaceCreateFlagsKHR -> Int -> IO Win32SurfaceCreateFlagsKHR #

pokeElemOff :: Ptr Win32SurfaceCreateFlagsKHR -> Int -> Win32SurfaceCreateFlagsKHR -> IO () #

peekByteOff :: Ptr b -> Int -> IO Win32SurfaceCreateFlagsKHR #

pokeByteOff :: Ptr b -> Int -> Win32SurfaceCreateFlagsKHR -> IO () #

peek :: Ptr Win32SurfaceCreateFlagsKHR -> IO Win32SurfaceCreateFlagsKHR #

poke :: Ptr Win32SurfaceCreateFlagsKHR -> Win32SurfaceCreateFlagsKHR -> IO () #

Bits Win32SurfaceCreateFlagsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_win32_surface

Methods

(.&.) :: Win32SurfaceCreateFlagsKHR -> Win32SurfaceCreateFlagsKHR -> Win32SurfaceCreateFlagsKHR #

(.|.) :: Win32SurfaceCreateFlagsKHR -> Win32SurfaceCreateFlagsKHR -> Win32SurfaceCreateFlagsKHR #

xor :: Win32SurfaceCreateFlagsKHR -> Win32SurfaceCreateFlagsKHR -> Win32SurfaceCreateFlagsKHR #

complement :: Win32SurfaceCreateFlagsKHR -> Win32SurfaceCreateFlagsKHR #

shift :: Win32SurfaceCreateFlagsKHR -> Int -> Win32SurfaceCreateFlagsKHR #

rotate :: Win32SurfaceCreateFlagsKHR -> Int -> Win32SurfaceCreateFlagsKHR #

zeroBits :: Win32SurfaceCreateFlagsKHR #

bit :: Int -> Win32SurfaceCreateFlagsKHR #

setBit :: Win32SurfaceCreateFlagsKHR -> Int -> Win32SurfaceCreateFlagsKHR #

clearBit :: Win32SurfaceCreateFlagsKHR -> Int -> Win32SurfaceCreateFlagsKHR #

complementBit :: Win32SurfaceCreateFlagsKHR -> Int -> Win32SurfaceCreateFlagsKHR #

testBit :: Win32SurfaceCreateFlagsKHR -> Int -> Bool #

bitSizeMaybe :: Win32SurfaceCreateFlagsKHR -> Maybe Int #

bitSize :: Win32SurfaceCreateFlagsKHR -> Int #

isSigned :: Win32SurfaceCreateFlagsKHR -> Bool #

shiftL :: Win32SurfaceCreateFlagsKHR -> Int -> Win32SurfaceCreateFlagsKHR #

unsafeShiftL :: Win32SurfaceCreateFlagsKHR -> Int -> Win32SurfaceCreateFlagsKHR #

shiftR :: Win32SurfaceCreateFlagsKHR -> Int -> Win32SurfaceCreateFlagsKHR #

unsafeShiftR :: Win32SurfaceCreateFlagsKHR -> Int -> Win32SurfaceCreateFlagsKHR #

rotateL :: Win32SurfaceCreateFlagsKHR -> Int -> Win32SurfaceCreateFlagsKHR #

rotateR :: Win32SurfaceCreateFlagsKHR -> Int -> Win32SurfaceCreateFlagsKHR #

popCount :: Win32SurfaceCreateFlagsKHR -> Int #

Zero Win32SurfaceCreateFlagsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_win32_surface

Methods

zero :: Win32SurfaceCreateFlagsKHR Source #

type KHR_WIN32_SURFACE_SPEC_VERSION = 6 Source #

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

type KHR_WIN32_SURFACE_EXTENSION_NAME = "VK_KHR_win32_surface" Source #

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

type HINSTANCE = Ptr () Source #

type HWND = Ptr () Source #

newtype SurfaceKHR Source #

VkSurfaceKHR - Opaque handle to a surface object

Description

The VK_KHR_surface extension declares the SurfaceKHR object, and provides a function for destroying SurfaceKHR objects. Separate platform-specific extensions each provide a function for creating a SurfaceKHR object for the respective platform. From the application’s perspective this is an opaque handle, just like the handles of other Vulkan objects.

See Also

PhysicalDeviceSurfaceInfo2KHR, SwapchainCreateInfoKHR, createAndroidSurfaceKHR, createDirectFBSurfaceEXT, createDisplayPlaneSurfaceKHR, createHeadlessSurfaceEXT, createIOSSurfaceMVK, createImagePipeSurfaceFUCHSIA, createMacOSSurfaceMVK, createMetalSurfaceEXT, createStreamDescriptorSurfaceGGP, createViSurfaceNN, createWaylandSurfaceKHR, createWin32SurfaceKHR, createXcbSurfaceKHR, createXlibSurfaceKHR, destroySurfaceKHR, getDeviceGroupSurfacePresentModesKHR, getPhysicalDevicePresentRectanglesKHR, getPhysicalDeviceSurfaceCapabilities2EXT, getPhysicalDeviceSurfaceCapabilitiesKHR, getPhysicalDeviceSurfaceFormatsKHR, getPhysicalDeviceSurfacePresentModesKHR, getPhysicalDeviceSurfaceSupportKHR

Constructors

SurfaceKHR Word64 

Instances

Instances details
Eq SurfaceKHR Source # 
Instance details

Defined in Vulkan.Extensions.Handles

Methods

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

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

Ord SurfaceKHR Source # 
Instance details

Defined in Vulkan.Extensions.Handles

Methods

compare :: SurfaceKHR -> SurfaceKHR -> Ordering #

(<) :: SurfaceKHR -> SurfaceKHR -> Bool #

(<=) :: SurfaceKHR -> SurfaceKHR -> Bool #

(>) :: SurfaceKHR -> SurfaceKHR -> Bool #

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

max :: SurfaceKHR -> SurfaceKHR -> SurfaceKHR #

min :: SurfaceKHR -> SurfaceKHR -> SurfaceKHR #

Show SurfaceKHR Source # 
Instance details

Defined in Vulkan.Extensions.Handles

Methods

showsPrec :: Int -> SurfaceKHR -> ShowS #

show :: SurfaceKHR -> String #

showList :: [SurfaceKHR] -> ShowS #

Storable SurfaceKHR Source # 
Instance details

Defined in Vulkan.Extensions.Handles

Methods

sizeOf :: SurfaceKHR -> Int #

alignment :: SurfaceKHR -> Int #

peekElemOff :: Ptr SurfaceKHR -> Int -> IO SurfaceKHR #

pokeElemOff :: Ptr SurfaceKHR -> Int -> SurfaceKHR -> IO () #

peekByteOff :: Ptr b -> Int -> IO SurfaceKHR #

pokeByteOff :: Ptr b -> Int -> SurfaceKHR -> IO () #

peek :: Ptr SurfaceKHR -> IO SurfaceKHR #

poke :: Ptr SurfaceKHR -> SurfaceKHR -> IO () #

Zero SurfaceKHR Source # 
Instance details

Defined in Vulkan.Extensions.Handles

Methods

zero :: SurfaceKHR Source #

HasObjectType SurfaceKHR Source # 
Instance details

Defined in Vulkan.Extensions.Handles

Methods

objectTypeAndHandle :: SurfaceKHR -> (ObjectType, Word64) Source #

IsHandle SurfaceKHR Source # 
Instance details

Defined in Vulkan.Extensions.Handles