vulkan-3.26.1: Bindings to the Vulkan graphics API.
Safe HaskellSafe-Inferred
LanguageHaskell2010

Vulkan.Extensions.VK_EXT_directfb_surface

Description

Name

VK_EXT_directfb_surface - instance extension

VK_EXT_directfb_surface

Name String
VK_EXT_directfb_surface
Extension Type
Instance extension
Registered Extension Number
347
Revision
1
Ratification Status
Not ratified
Extension and Version Dependencies
VK_KHR_surface
Contact

Other Extension Metadata

Last Modified Date
2020-06-16
IP Status
No known IP claims.
Contributors
  • Nicolas Caramelli

Description

The VK_EXT_directfb_surface extension is an instance extension. It provides a mechanism to create a SurfaceKHR object (defined by the VK_KHR_surface extension) that refers to a DirectFB IDirectFBSurface, as well as a query to determine support for rendering via DirectFB.

New Commands

New Structures

New Bitmasks

New Enum Constants

Version History

  • Revision 1, 2020-06-16 (Nicolas Caramelli)

    • Initial version

See Also

DirectFBSurfaceCreateFlagsEXT, DirectFBSurfaceCreateInfoEXT, createDirectFBSurfaceEXT, getPhysicalDeviceDirectFBPresentationSupportEXT

Document Notes

For more information, see the Vulkan Specification

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

Synopsis

Documentation

createDirectFBSurfaceEXT Source #

Arguments

:: forall io. MonadIO io 
=> Instance

instance is the instance to associate the surface with.

-> DirectFBSurfaceCreateInfoEXT

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

vkCreateDirectFBSurfaceEXT - Create a SurfaceKHR object for a DirectFB surface

Valid Usage (Implicit)

  • instance must be a valid Instance handle

Return Codes

Success
Failure

See Also

VK_EXT_directfb_surface, AllocationCallbacks, DirectFBSurfaceCreateInfoEXT, Instance, SurfaceKHR

getPhysicalDeviceDirectFBPresentationSupportEXT 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

-> ("dfb" ::: Ptr IDirectFB)

dfb is a pointer to the IDirectFB main interface of DirectFB.

dfb must be a valid pointer to an IDirectFB value

-> io Bool 

vkGetPhysicalDeviceDirectFBPresentationSupportEXT - Query physical device for presentation with DirectFB

Description

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

Valid Usage (Implicit)

See Also

VK_EXT_directfb_surface, PhysicalDevice

data DirectFBSurfaceCreateInfoEXT Source #

VkDirectFBSurfaceCreateInfoEXT - Structure specifying parameters of a newly created DirectFB surface object

Valid Usage (Implicit)

See Also

VK_EXT_directfb_surface, DirectFBSurfaceCreateFlagsEXT, StructureType, createDirectFBSurfaceEXT

Constructors

DirectFBSurfaceCreateInfoEXT 

Fields

Instances

Instances details
Storable DirectFBSurfaceCreateInfoEXT Source # 
Instance details

Defined in Vulkan.Extensions.VK_EXT_directfb_surface

Methods

sizeOf :: DirectFBSurfaceCreateInfoEXT -> Int #

alignment :: DirectFBSurfaceCreateInfoEXT -> Int #

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

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

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

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

peek :: Ptr DirectFBSurfaceCreateInfoEXT -> IO DirectFBSurfaceCreateInfoEXT #

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

Show DirectFBSurfaceCreateInfoEXT Source # 
Instance details

Defined in Vulkan.Extensions.VK_EXT_directfb_surface

Methods

showsPrec :: Int -> DirectFBSurfaceCreateInfoEXT -> ShowS #

show :: DirectFBSurfaceCreateInfoEXT -> String #

showList :: [DirectFBSurfaceCreateInfoEXT] -> ShowS #

Eq DirectFBSurfaceCreateInfoEXT Source # 
Instance details

Defined in Vulkan.Extensions.VK_EXT_directfb_surface

Methods

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

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

FromCStruct DirectFBSurfaceCreateInfoEXT Source # 
Instance details

Defined in Vulkan.Extensions.VK_EXT_directfb_surface

Methods

peekCStruct :: Ptr DirectFBSurfaceCreateInfoEXT -> IO DirectFBSurfaceCreateInfoEXT Source #

ToCStruct DirectFBSurfaceCreateInfoEXT Source # 
Instance details

Defined in Vulkan.Extensions.VK_EXT_directfb_surface

Methods

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

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

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

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

cStructSize :: Int Source #

cStructAlignment :: Int Source #

Zero DirectFBSurfaceCreateInfoEXT Source # 
Instance details

Defined in Vulkan.Extensions.VK_EXT_directfb_surface

Methods

zero :: DirectFBSurfaceCreateInfoEXT Source #

newtype DirectFBSurfaceCreateFlagsEXT Source #

VkDirectFBSurfaceCreateFlagsEXT - Reserved for future use

Description

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

See Also

VK_EXT_directfb_surface, DirectFBSurfaceCreateInfoEXT

Constructors

DirectFBSurfaceCreateFlagsEXT Flags 

Instances

Instances details
Storable DirectFBSurfaceCreateFlagsEXT Source # 
Instance details

Defined in Vulkan.Extensions.VK_EXT_directfb_surface

Methods

sizeOf :: DirectFBSurfaceCreateFlagsEXT -> Int #

alignment :: DirectFBSurfaceCreateFlagsEXT -> Int #

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

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

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

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

peek :: Ptr DirectFBSurfaceCreateFlagsEXT -> IO DirectFBSurfaceCreateFlagsEXT #

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

Bits DirectFBSurfaceCreateFlagsEXT Source # 
Instance details

Defined in Vulkan.Extensions.VK_EXT_directfb_surface

Methods

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

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

xor :: DirectFBSurfaceCreateFlagsEXT -> DirectFBSurfaceCreateFlagsEXT -> DirectFBSurfaceCreateFlagsEXT #

complement :: DirectFBSurfaceCreateFlagsEXT -> DirectFBSurfaceCreateFlagsEXT #

shift :: DirectFBSurfaceCreateFlagsEXT -> Int -> DirectFBSurfaceCreateFlagsEXT #

rotate :: DirectFBSurfaceCreateFlagsEXT -> Int -> DirectFBSurfaceCreateFlagsEXT #

zeroBits :: DirectFBSurfaceCreateFlagsEXT #

bit :: Int -> DirectFBSurfaceCreateFlagsEXT #

setBit :: DirectFBSurfaceCreateFlagsEXT -> Int -> DirectFBSurfaceCreateFlagsEXT #

clearBit :: DirectFBSurfaceCreateFlagsEXT -> Int -> DirectFBSurfaceCreateFlagsEXT #

complementBit :: DirectFBSurfaceCreateFlagsEXT -> Int -> DirectFBSurfaceCreateFlagsEXT #

testBit :: DirectFBSurfaceCreateFlagsEXT -> Int -> Bool #

bitSizeMaybe :: DirectFBSurfaceCreateFlagsEXT -> Maybe Int #

bitSize :: DirectFBSurfaceCreateFlagsEXT -> Int #

isSigned :: DirectFBSurfaceCreateFlagsEXT -> Bool #

shiftL :: DirectFBSurfaceCreateFlagsEXT -> Int -> DirectFBSurfaceCreateFlagsEXT #

unsafeShiftL :: DirectFBSurfaceCreateFlagsEXT -> Int -> DirectFBSurfaceCreateFlagsEXT #

shiftR :: DirectFBSurfaceCreateFlagsEXT -> Int -> DirectFBSurfaceCreateFlagsEXT #

unsafeShiftR :: DirectFBSurfaceCreateFlagsEXT -> Int -> DirectFBSurfaceCreateFlagsEXT #

rotateL :: DirectFBSurfaceCreateFlagsEXT -> Int -> DirectFBSurfaceCreateFlagsEXT #

rotateR :: DirectFBSurfaceCreateFlagsEXT -> Int -> DirectFBSurfaceCreateFlagsEXT #

popCount :: DirectFBSurfaceCreateFlagsEXT -> Int #

FiniteBits DirectFBSurfaceCreateFlagsEXT Source # 
Instance details

Defined in Vulkan.Extensions.VK_EXT_directfb_surface

Methods

finiteBitSize :: DirectFBSurfaceCreateFlagsEXT -> Int #

countLeadingZeros :: DirectFBSurfaceCreateFlagsEXT -> Int #

countTrailingZeros :: DirectFBSurfaceCreateFlagsEXT -> Int #

Read DirectFBSurfaceCreateFlagsEXT Source # 
Instance details

Defined in Vulkan.Extensions.VK_EXT_directfb_surface

Methods

readsPrec :: Int -> ReadS DirectFBSurfaceCreateFlagsEXT #

readList :: ReadS [DirectFBSurfaceCreateFlagsEXT] #

readPrec :: ReadPrec DirectFBSurfaceCreateFlagsEXT #

readListPrec :: ReadPrec [DirectFBSurfaceCreateFlagsEXT] #

Show DirectFBSurfaceCreateFlagsEXT Source # 
Instance details

Defined in Vulkan.Extensions.VK_EXT_directfb_surface

Methods

showsPrec :: Int -> DirectFBSurfaceCreateFlagsEXT -> ShowS #

show :: DirectFBSurfaceCreateFlagsEXT -> String #

showList :: [DirectFBSurfaceCreateFlagsEXT] -> ShowS #

Eq DirectFBSurfaceCreateFlagsEXT Source # 
Instance details

Defined in Vulkan.Extensions.VK_EXT_directfb_surface

Methods

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

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

Ord DirectFBSurfaceCreateFlagsEXT Source # 
Instance details

Defined in Vulkan.Extensions.VK_EXT_directfb_surface

Methods

compare :: DirectFBSurfaceCreateFlagsEXT -> DirectFBSurfaceCreateFlagsEXT -> Ordering #

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

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

(>) :: DirectFBSurfaceCreateFlagsEXT -> DirectFBSurfaceCreateFlagsEXT -> Bool #

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

max :: DirectFBSurfaceCreateFlagsEXT -> DirectFBSurfaceCreateFlagsEXT -> DirectFBSurfaceCreateFlagsEXT #

min :: DirectFBSurfaceCreateFlagsEXT -> DirectFBSurfaceCreateFlagsEXT -> DirectFBSurfaceCreateFlagsEXT #

Zero DirectFBSurfaceCreateFlagsEXT Source # 
Instance details

Defined in Vulkan.Extensions.VK_EXT_directfb_surface

Methods

zero :: DirectFBSurfaceCreateFlagsEXT Source #

type EXT_DIRECTFB_SURFACE_SPEC_VERSION = 1 Source #

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

type EXT_DIRECTFB_SURFACE_EXTENSION_NAME = "VK_EXT_directfb_surface" Source #

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

data IDirectFB Source #

data IDirectFBSurface 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

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

Constructors

SurfaceKHR Word64 

Instances

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

Show SurfaceKHR Source # 
Instance details

Defined in Vulkan.Extensions.Handles

Methods

showsPrec :: Int -> SurfaceKHR -> ShowS #

show :: SurfaceKHR -> String #

showList :: [SurfaceKHR] -> ShowS #

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 #

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

Zero SurfaceKHR Source # 
Instance details

Defined in Vulkan.Extensions.Handles

Methods

zero :: SurfaceKHR Source #