Vulkan.Extensions.VK_EXT_headless_surface

Documentation

createHeadlessSurfaceEXT

Arguments

:: forall io. MonadIO io

=> Instance

instance is the instance to associate the surface with.

-> HeadlessSurfaceCreateInfoEXT

pCreateInfo is a pointer to a HeadlessSurfaceCreateInfoEXT 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

vkCreateHeadlessSurfaceEXT - Create a headless SurfaceKHR object

Valid Usage (Implicit)

• instance must be a valid Instance handle

• pCreateInfo must be a valid pointer to a valid HeadlessSurfaceCreateInfoEXT structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• pSurface must be a valid pointer to a SurfaceKHR handle

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

AllocationCallbacks, HeadlessSurfaceCreateInfoEXT, Instance, SurfaceKHR

data HeadlessSurfaceCreateInfoEXT

VkHeadlessSurfaceCreateInfoEXT - Structure specifying parameters of a newly created headless surface object

Valid Usage (Implicit)

See Also

HeadlessSurfaceCreateFlagsEXT, StructureType, createHeadlessSurfaceEXT

Constructors

HeadlessSurfaceCreateInfoEXT

Fields

• flags :: HeadlessSurfaceCreateFlagsEXT

  flags is reserved for future use.

  flags must be 0

Instances

Eq HeadlessSurfaceCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_headless_surface

Methods

(==) :: HeadlessSurfaceCreateInfoEXT -> HeadlessSurfaceCreateInfoEXT -> Bool

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

Show HeadlessSurfaceCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_headless_surface

Methods

showsPrec :: Int -> HeadlessSurfaceCreateInfoEXT -> ShowS

show :: HeadlessSurfaceCreateInfoEXT -> String

showList :: [HeadlessSurfaceCreateInfoEXT] -> ShowS

Generic HeadlessSurfaceCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_headless_surface

Associated Types

type Rep HeadlessSurfaceCreateInfoEXT :: Type -> Type

Methods

from :: HeadlessSurfaceCreateInfoEXT -> Rep HeadlessSurfaceCreateInfoEXT x

to :: Rep HeadlessSurfaceCreateInfoEXT x -> HeadlessSurfaceCreateInfoEXT

Storable HeadlessSurfaceCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_headless_surface

Methods

sizeOf :: HeadlessSurfaceCreateInfoEXT -> Int

alignment :: HeadlessSurfaceCreateInfoEXT -> Int

peekElemOff :: Ptr HeadlessSurfaceCreateInfoEXT -> Int -> IO HeadlessSurfaceCreateInfoEXT

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

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

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

peek :: Ptr HeadlessSurfaceCreateInfoEXT -> IO HeadlessSurfaceCreateInfoEXT

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

FromCStruct HeadlessSurfaceCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_headless_surface

Methods

peekCStruct :: Ptr HeadlessSurfaceCreateInfoEXT -> IO HeadlessSurfaceCreateInfoEXT

ToCStruct HeadlessSurfaceCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_headless_surface

Methods

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

pokeCStruct :: Ptr HeadlessSurfaceCreateInfoEXT -> HeadlessSurfaceCreateInfoEXT -> IO b -> IO b

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

pokeZeroCStruct :: Ptr HeadlessSurfaceCreateInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero HeadlessSurfaceCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_headless_surface

Methods

zero :: HeadlessSurfaceCreateInfoEXT

type Rep HeadlessSurfaceCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_headless_surface

type Rep HeadlessSurfaceCreateInfoEXT = D1 ('MetaData "HeadlessSurfaceCreateInfoEXT" "Vulkan.Extensions.VK_EXT_headless_surface" "vulkan-3.6.1-inplace" 'False) (C1 ('MetaCons "HeadlessSurfaceCreateInfoEXT" 'PrefixI 'True) (S1 ('MetaSel ('Just "flags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HeadlessSurfaceCreateFlagsEXT)))

newtype HeadlessSurfaceCreateFlagsEXT

VkHeadlessSurfaceCreateFlagsEXT - Reserved for future use

Description

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

See Also

HeadlessSurfaceCreateInfoEXT

Constructors

HeadlessSurfaceCreateFlagsEXT Flags

Instances

Eq HeadlessSurfaceCreateFlagsEXT

Defined in Vulkan.Extensions.VK_EXT_headless_surface

Methods

(==) :: HeadlessSurfaceCreateFlagsEXT -> HeadlessSurfaceCreateFlagsEXT -> Bool

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

Ord HeadlessSurfaceCreateFlagsEXT

Defined in Vulkan.Extensions.VK_EXT_headless_surface

Methods

compare :: HeadlessSurfaceCreateFlagsEXT -> HeadlessSurfaceCreateFlagsEXT -> Ordering

(<) :: HeadlessSurfaceCreateFlagsEXT -> HeadlessSurfaceCreateFlagsEXT -> Bool

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

(>) :: HeadlessSurfaceCreateFlagsEXT -> HeadlessSurfaceCreateFlagsEXT -> Bool

(>=) :: HeadlessSurfaceCreateFlagsEXT -> HeadlessSurfaceCreateFlagsEXT -> Bool

max :: HeadlessSurfaceCreateFlagsEXT -> HeadlessSurfaceCreateFlagsEXT -> HeadlessSurfaceCreateFlagsEXT

min :: HeadlessSurfaceCreateFlagsEXT -> HeadlessSurfaceCreateFlagsEXT -> HeadlessSurfaceCreateFlagsEXT

Read HeadlessSurfaceCreateFlagsEXT

Defined in Vulkan.Extensions.VK_EXT_headless_surface

Methods

readsPrec :: Int -> ReadS HeadlessSurfaceCreateFlagsEXT

readList :: ReadS [HeadlessSurfaceCreateFlagsEXT]

readPrec :: ReadPrec HeadlessSurfaceCreateFlagsEXT

readListPrec :: ReadPrec [HeadlessSurfaceCreateFlagsEXT]

Show HeadlessSurfaceCreateFlagsEXT

Defined in Vulkan.Extensions.VK_EXT_headless_surface

Methods

showsPrec :: Int -> HeadlessSurfaceCreateFlagsEXT -> ShowS

show :: HeadlessSurfaceCreateFlagsEXT -> String

showList :: [HeadlessSurfaceCreateFlagsEXT] -> ShowS

Storable HeadlessSurfaceCreateFlagsEXT

Defined in Vulkan.Extensions.VK_EXT_headless_surface

Methods

sizeOf :: HeadlessSurfaceCreateFlagsEXT -> Int

alignment :: HeadlessSurfaceCreateFlagsEXT -> Int

peekElemOff :: Ptr HeadlessSurfaceCreateFlagsEXT -> Int -> IO HeadlessSurfaceCreateFlagsEXT

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

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

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

peek :: Ptr HeadlessSurfaceCreateFlagsEXT -> IO HeadlessSurfaceCreateFlagsEXT

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

Bits HeadlessSurfaceCreateFlagsEXT

Defined in Vulkan.Extensions.VK_EXT_headless_surface

Methods

(.&.) :: HeadlessSurfaceCreateFlagsEXT -> HeadlessSurfaceCreateFlagsEXT -> HeadlessSurfaceCreateFlagsEXT

(.|.) :: HeadlessSurfaceCreateFlagsEXT -> HeadlessSurfaceCreateFlagsEXT -> HeadlessSurfaceCreateFlagsEXT

xor :: HeadlessSurfaceCreateFlagsEXT -> HeadlessSurfaceCreateFlagsEXT -> HeadlessSurfaceCreateFlagsEXT

complement :: HeadlessSurfaceCreateFlagsEXT -> HeadlessSurfaceCreateFlagsEXT

shift :: HeadlessSurfaceCreateFlagsEXT -> Int -> HeadlessSurfaceCreateFlagsEXT

rotate :: HeadlessSurfaceCreateFlagsEXT -> Int -> HeadlessSurfaceCreateFlagsEXT

zeroBits :: HeadlessSurfaceCreateFlagsEXT

bit :: Int -> HeadlessSurfaceCreateFlagsEXT

setBit :: HeadlessSurfaceCreateFlagsEXT -> Int -> HeadlessSurfaceCreateFlagsEXT

clearBit :: HeadlessSurfaceCreateFlagsEXT -> Int -> HeadlessSurfaceCreateFlagsEXT

complementBit :: HeadlessSurfaceCreateFlagsEXT -> Int -> HeadlessSurfaceCreateFlagsEXT

testBit :: HeadlessSurfaceCreateFlagsEXT -> Int -> Bool

bitSizeMaybe :: HeadlessSurfaceCreateFlagsEXT -> Maybe Int

bitSize :: HeadlessSurfaceCreateFlagsEXT -> Int

isSigned :: HeadlessSurfaceCreateFlagsEXT -> Bool

shiftL :: HeadlessSurfaceCreateFlagsEXT -> Int -> HeadlessSurfaceCreateFlagsEXT

unsafeShiftL :: HeadlessSurfaceCreateFlagsEXT -> Int -> HeadlessSurfaceCreateFlagsEXT

shiftR :: HeadlessSurfaceCreateFlagsEXT -> Int -> HeadlessSurfaceCreateFlagsEXT

unsafeShiftR :: HeadlessSurfaceCreateFlagsEXT -> Int -> HeadlessSurfaceCreateFlagsEXT

rotateL :: HeadlessSurfaceCreateFlagsEXT -> Int -> HeadlessSurfaceCreateFlagsEXT

rotateR :: HeadlessSurfaceCreateFlagsEXT -> Int -> HeadlessSurfaceCreateFlagsEXT

popCount :: HeadlessSurfaceCreateFlagsEXT -> Int

Zero HeadlessSurfaceCreateFlagsEXT

Defined in Vulkan.Extensions.VK_EXT_headless_surface

Methods

zero :: HeadlessSurfaceCreateFlagsEXT

type EXT_HEADLESS_SURFACE_SPEC_VERSION = 1

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

type EXT_HEADLESS_SURFACE_EXTENSION_NAME = "VK_EXT_headless_surface"

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

newtype SurfaceKHR

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

Eq SurfaceKHR

Defined in Vulkan.Extensions.Handles

Methods

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

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

Ord SurfaceKHR

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

Defined in Vulkan.Extensions.Handles

Methods

showsPrec :: Int -> SurfaceKHR -> ShowS

show :: SurfaceKHR -> String

showList :: [SurfaceKHR] -> ShowS

Storable SurfaceKHR

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

Defined in Vulkan.Extensions.Handles

Methods

zero :: SurfaceKHR

HasObjectType SurfaceKHR

Defined in Vulkan.Extensions.Handles

Methods

objectTypeAndHandle :: SurfaceKHR -> (ObjectType, Word64)

IsHandle SurfaceKHR

Defined in Vulkan.Extensions.Handles