Safe Haskell	Safe-Inferred
Language	Haskell2010

Vulkan.Extensions.VK_QNX_screen_surface

Description

Name

VK_QNX_screen_surface - instance extension

VK_QNX_screen_surface

Name String: VK_QNX_screen_surface

Extension Type

Instance extension

Registered Extension Number

379

Revision

1

Ratification Status

Not ratified

Extension and Version Dependencies

VK_KHR_surface

Contact

Mike Gorchak @mgorchak-blackberry%0A*Here describe the issue or question you have about the VK_QNX_screen_surface extension*

Other Extension Metadata

Last Modified Date: 2021-01-11

IP Status

No known IP claims.

Contributors

Mike Gorchak, BlackBerry Limited

Description

The VK_QNX_screen_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 QNX Screen window, as well as a query to determine support for rendering to a QNX Screen compositor.

New Commands

createScreenSurfaceQNX

getPhysicalDeviceScreenPresentationSupportQNX

New Structures

ScreenSurfaceCreateInfoQNX

New Bitmasks

ScreenSurfaceCreateFlagsQNX

New Enum Constants

QNX_SCREEN_SURFACE_EXTENSION_NAME

QNX_SCREEN_SURFACE_SPEC_VERSION
Extending StructureType:
- STRUCTURE_TYPE_SCREEN_SURFACE_CREATE_INFO_QNX

Version History

Revision 1, 2021-01-11 (Mike Gorchak)
- Initial draft.

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

createScreenSurfaceQNX :: forall io. MonadIO io => Instance -> ScreenSurfaceCreateInfoQNX -> ("allocator" ::: Maybe AllocationCallbacks) -> io SurfaceKHR
getPhysicalDeviceScreenPresentationSupportQNX :: forall io. MonadIO io => PhysicalDevice -> ("queueFamilyIndex" ::: Word32) -> Ptr Screen_window -> io Bool
data ScreenSurfaceCreateInfoQNX = ScreenSurfaceCreateInfoQNX {
- flags :: ScreenSurfaceCreateFlagsQNX
- context :: Ptr Screen_context
- window :: Ptr Screen_window
}
newtype ScreenSurfaceCreateFlagsQNX = ScreenSurfaceCreateFlagsQNX Flags
type QNX_SCREEN_SURFACE_SPEC_VERSION = 1
pattern QNX_SCREEN_SURFACE_SPEC_VERSION :: forall a. Integral a => a
type QNX_SCREEN_SURFACE_EXTENSION_NAME = "VK_QNX_screen_surface"
pattern QNX_SCREEN_SURFACE_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a
data Screen_window
data Screen_context
newtype SurfaceKHR = SurfaceKHR Word64

Documentation

createScreenSurfaceQNX Source #

Arguments

:: forall io. MonadIO io
=> Instance	`instance` is the instance to associate the surface with.
-> ScreenSurfaceCreateInfoQNX	`pCreateInfo` is a pointer to a `ScreenSurfaceCreateInfoQNX` 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

vkCreateScreenSurfaceQNX - Create a SurfaceKHR object for a QNX Screen window

Valid Usage (Implicit)

instance must be a valid Instance handle

pCreateInfo must be a valid pointer to a valid ScreenSurfaceCreateInfoQNX 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

Description

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

Valid Usage (Implicit)

Description

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

Storable ScreenSurfaceCreateFlagsQNX Source #
Instance details Defined in Vulkan.Extensions.VK_QNX_screen_surface Methods sizeOf :: ScreenSurfaceCreateFlagsQNX -> Int # alignment :: ScreenSurfaceCreateFlagsQNX -> Int # peekElemOff :: Ptr ScreenSurfaceCreateFlagsQNX -> Int -> IO ScreenSurfaceCreateFlagsQNX # pokeElemOff :: Ptr ScreenSurfaceCreateFlagsQNX -> Int -> ScreenSurfaceCreateFlagsQNX -> IO () # peekByteOff :: Ptr b -> Int -> IO ScreenSurfaceCreateFlagsQNX # pokeByteOff :: Ptr b -> Int -> ScreenSurfaceCreateFlagsQNX -> IO () # peek :: Ptr ScreenSurfaceCreateFlagsQNX -> IO ScreenSurfaceCreateFlagsQNX # poke :: Ptr ScreenSurfaceCreateFlagsQNX -> ScreenSurfaceCreateFlagsQNX -> IO () #
Bits ScreenSurfaceCreateFlagsQNX Source #
Instance details Defined in Vulkan.Extensions.VK_QNX_screen_surface Methods (.&.) :: ScreenSurfaceCreateFlagsQNX -> ScreenSurfaceCreateFlagsQNX -> ScreenSurfaceCreateFlagsQNX # (.\|.) :: ScreenSurfaceCreateFlagsQNX -> ScreenSurfaceCreateFlagsQNX -> ScreenSurfaceCreateFlagsQNX # xor :: ScreenSurfaceCreateFlagsQNX -> ScreenSurfaceCreateFlagsQNX -> ScreenSurfaceCreateFlagsQNX # complement :: ScreenSurfaceCreateFlagsQNX -> ScreenSurfaceCreateFlagsQNX # shift :: ScreenSurfaceCreateFlagsQNX -> Int -> ScreenSurfaceCreateFlagsQNX # rotate :: ScreenSurfaceCreateFlagsQNX -> Int -> ScreenSurfaceCreateFlagsQNX # zeroBits :: ScreenSurfaceCreateFlagsQNX # bit :: Int -> ScreenSurfaceCreateFlagsQNX # setBit :: ScreenSurfaceCreateFlagsQNX -> Int -> ScreenSurfaceCreateFlagsQNX # clearBit :: ScreenSurfaceCreateFlagsQNX -> Int -> ScreenSurfaceCreateFlagsQNX # complementBit :: ScreenSurfaceCreateFlagsQNX -> Int -> ScreenSurfaceCreateFlagsQNX # testBit :: ScreenSurfaceCreateFlagsQNX -> Int -> Bool # bitSizeMaybe :: ScreenSurfaceCreateFlagsQNX -> Maybe Int # bitSize :: ScreenSurfaceCreateFlagsQNX -> Int # isSigned :: ScreenSurfaceCreateFlagsQNX -> Bool # shiftL :: ScreenSurfaceCreateFlagsQNX -> Int -> ScreenSurfaceCreateFlagsQNX # unsafeShiftL :: ScreenSurfaceCreateFlagsQNX -> Int -> ScreenSurfaceCreateFlagsQNX # shiftR :: ScreenSurfaceCreateFlagsQNX -> Int -> ScreenSurfaceCreateFlagsQNX # unsafeShiftR :: ScreenSurfaceCreateFlagsQNX -> Int -> ScreenSurfaceCreateFlagsQNX # rotateL :: ScreenSurfaceCreateFlagsQNX -> Int -> ScreenSurfaceCreateFlagsQNX # rotateR :: ScreenSurfaceCreateFlagsQNX -> Int -> ScreenSurfaceCreateFlagsQNX # popCount :: ScreenSurfaceCreateFlagsQNX -> Int #
FiniteBits ScreenSurfaceCreateFlagsQNX Source #
Instance details Defined in Vulkan.Extensions.VK_QNX_screen_surface Methods finiteBitSize :: ScreenSurfaceCreateFlagsQNX -> Int # countLeadingZeros :: ScreenSurfaceCreateFlagsQNX -> Int # countTrailingZeros :: ScreenSurfaceCreateFlagsQNX -> Int #
Read ScreenSurfaceCreateFlagsQNX Source #
Instance details Defined in Vulkan.Extensions.VK_QNX_screen_surface Methods readsPrec :: Int -> ReadS ScreenSurfaceCreateFlagsQNX # readList :: ReadS [ScreenSurfaceCreateFlagsQNX] # readPrec :: ReadPrec ScreenSurfaceCreateFlagsQNX # readListPrec :: ReadPrec [ScreenSurfaceCreateFlagsQNX] #
Show ScreenSurfaceCreateFlagsQNX Source #
Instance details Defined in Vulkan.Extensions.VK_QNX_screen_surface Methods showsPrec :: Int -> ScreenSurfaceCreateFlagsQNX -> ShowS # show :: ScreenSurfaceCreateFlagsQNX -> String # showList :: [ScreenSurfaceCreateFlagsQNX] -> ShowS #
Eq ScreenSurfaceCreateFlagsQNX Source #
Instance details Defined in Vulkan.Extensions.VK_QNX_screen_surface Methods (==) :: ScreenSurfaceCreateFlagsQNX -> ScreenSurfaceCreateFlagsQNX -> Bool # (/=) :: ScreenSurfaceCreateFlagsQNX -> ScreenSurfaceCreateFlagsQNX -> Bool #
Ord ScreenSurfaceCreateFlagsQNX Source #
Instance details Defined in Vulkan.Extensions.VK_QNX_screen_surface Methods compare :: ScreenSurfaceCreateFlagsQNX -> ScreenSurfaceCreateFlagsQNX -> Ordering # (<) :: ScreenSurfaceCreateFlagsQNX -> ScreenSurfaceCreateFlagsQNX -> Bool # (<=) :: ScreenSurfaceCreateFlagsQNX -> ScreenSurfaceCreateFlagsQNX -> Bool # (>) :: ScreenSurfaceCreateFlagsQNX -> ScreenSurfaceCreateFlagsQNX -> Bool # (>=) :: ScreenSurfaceCreateFlagsQNX -> ScreenSurfaceCreateFlagsQNX -> Bool # max :: ScreenSurfaceCreateFlagsQNX -> ScreenSurfaceCreateFlagsQNX -> ScreenSurfaceCreateFlagsQNX # min :: ScreenSurfaceCreateFlagsQNX -> ScreenSurfaceCreateFlagsQNX -> ScreenSurfaceCreateFlagsQNX #
Zero ScreenSurfaceCreateFlagsQNX Source #
Instance details Defined in Vulkan.Extensions.VK_QNX_screen_surface Methods zero :: ScreenSurfaceCreateFlagsQNX Source #

type QNX_SCREEN_SURFACE_SPEC_VERSION = 1 Source #

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

type QNX_SCREEN_SURFACE_EXTENSION_NAME = "VK_QNX_screen_surface" Source #

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

data Screen_window Source #

data Screen_context 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.

Storable ScreenSurfaceCreateInfoQNX Source #
Instance details Defined in Vulkan.Extensions.VK_QNX_screen_surface Methods sizeOf :: ScreenSurfaceCreateInfoQNX -> Int # alignment :: ScreenSurfaceCreateInfoQNX -> Int # peekElemOff :: Ptr ScreenSurfaceCreateInfoQNX -> Int -> IO ScreenSurfaceCreateInfoQNX # pokeElemOff :: Ptr ScreenSurfaceCreateInfoQNX -> Int -> ScreenSurfaceCreateInfoQNX -> IO () # peekByteOff :: Ptr b -> Int -> IO ScreenSurfaceCreateInfoQNX # pokeByteOff :: Ptr b -> Int -> ScreenSurfaceCreateInfoQNX -> IO () # peek :: Ptr ScreenSurfaceCreateInfoQNX -> IO ScreenSurfaceCreateInfoQNX # poke :: Ptr ScreenSurfaceCreateInfoQNX -> ScreenSurfaceCreateInfoQNX -> IO () #
Show ScreenSurfaceCreateInfoQNX Source #
Instance details Defined in Vulkan.Extensions.VK_QNX_screen_surface Methods showsPrec :: Int -> ScreenSurfaceCreateInfoQNX -> ShowS # show :: ScreenSurfaceCreateInfoQNX -> String # showList :: [ScreenSurfaceCreateInfoQNX] -> ShowS #
Eq ScreenSurfaceCreateInfoQNX Source #
Instance details Defined in Vulkan.Extensions.VK_QNX_screen_surface Methods (==) :: ScreenSurfaceCreateInfoQNX -> ScreenSurfaceCreateInfoQNX -> Bool # (/=) :: ScreenSurfaceCreateInfoQNX -> ScreenSurfaceCreateInfoQNX -> Bool #
FromCStruct ScreenSurfaceCreateInfoQNX Source #
Instance details Defined in Vulkan.Extensions.VK_QNX_screen_surface Methods peekCStruct :: Ptr ScreenSurfaceCreateInfoQNX -> IO ScreenSurfaceCreateInfoQNX Source #
ToCStruct ScreenSurfaceCreateInfoQNX Source #
Instance details Defined in Vulkan.Extensions.VK_QNX_screen_surface Methods withCStruct :: ScreenSurfaceCreateInfoQNX -> (Ptr ScreenSurfaceCreateInfoQNX -> IO b) -> IO b Source # pokeCStruct :: Ptr ScreenSurfaceCreateInfoQNX -> ScreenSurfaceCreateInfoQNX -> IO b -> IO b Source # withZeroCStruct :: (Ptr ScreenSurfaceCreateInfoQNX -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr ScreenSurfaceCreateInfoQNX -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero ScreenSurfaceCreateInfoQNX Source #
Instance details Defined in Vulkan.Extensions.VK_QNX_screen_surface Methods zero :: ScreenSurfaceCreateInfoQNX Source #

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 #

Name

VK_QNX_screen_surface

Other Extension Metadata

Description

New Commands

New Structures

New Bitmasks

New Enum Constants

Version History

See Also

Document Notes

Documentation

Valid Usage (Implicit)

Return Codes

See Also

Description

Valid Usage (Implicit)

See Also

Valid Usage (Implicit)

See Also

Instances

Description

See Also

Instances

Description

See Also

Instances

:: 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`
-> Ptr Screen_window	`window` is the QNX Screen `window` object. `window` must be a valid pointer to a `Screen_window` value
-> io Bool

ScreenSurfaceCreateInfoQNX
Fields flags :: ScreenSurfaceCreateFlagsQNX `flags` is reserved for future use. `flags` must be `0` context :: Ptr Screen_context `context` and `window` are QNX Screen `context` and `window` to associate the surface with. `context` must point to a valid QNX Screen `struct` _screen_context window :: Ptr Screen_window `window` must point to a valid QNX Screen `struct` _screen_window