Safe Haskell	Safe-Inferred
Language	Haskell2010

Vulkan.Extensions.VK_QNX_external_memory_screen_buffer

Description

Name

VK_QNX_external_memory_screen_buffer - device extension

VK_QNX_external_memory_screen_buffer

Name String: VK_QNX_external_memory_screen_buffer

Extension Type: Device extension
Registered Extension Number: 530
Revision: 1
Ratification Status: Not ratified
Extension and Version Dependencies

VK_KHR_sampler_ycbcr_conversion and

VK_KHR_external_memory and

VK_KHR_dedicated_allocation or

Version 1.1 and VK_EXT_queue_family_foreign

Contact

Other Extension Metadata

Last Modified Date: 2023-05-17

IP Status

No known IP claims.

Contributors

Mike Gorchak, QNX / Blackberry Limited
Aaron Ruby, QNX / Blackberry Limited

Description

This extension enables an application to import QNX Screen Screen_buffer objects created outside of the Vulkan device into Vulkan memory objects, where they can be bound to images and buffers.

Some Screen_buffer images have implementation-defined /external formats that may/ not correspond to Vulkan formats. Sampler Y′CBCR conversion can be used to sample from these images and convert them to a known color space.

Screen_buffer is strongly typed, so naming the handle type is redundant. The internal layout and therefore size of a Screen_buffer image may depend on native usage flags that do not have corresponding Vulkan counterparts.

New Commands

getScreenBufferPropertiesQNX

New Structures

ScreenBufferPropertiesQNX

Extending ImageCreateInfo, SamplerYcbcrConversionCreateInfo:
- ExternalFormatQNX
Extending MemoryAllocateInfo:
- ImportScreenBufferInfoQNX
Extending PhysicalDeviceFeatures2, DeviceCreateInfo:
- PhysicalDeviceExternalMemoryScreenBufferFeaturesQNX
Extending ScreenBufferPropertiesQNX:
- ScreenBufferFormatPropertiesQNX

New Enum Constants

QNX_EXTERNAL_MEMORY_SCREEN_BUFFER_EXTENSION_NAME

Version History

Revision 1, 2023-05-17 (Mike Gorchak)
- Initial version

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

getScreenBufferPropertiesQNX :: forall a io. (Extendss ScreenBufferPropertiesQNX a, PokeChain a, PeekChain a, MonadIO io) => Device -> Ptr Screen_buffer -> io (ScreenBufferPropertiesQNX a)
data ImportScreenBufferInfoQNX = ImportScreenBufferInfoQNX {
- buffer :: Ptr Screen_buffer
}
data ScreenBufferPropertiesQNX (es :: [Type]) = ScreenBufferPropertiesQNX {
- next :: Chain es
- allocationSize :: DeviceSize
- memoryTypeBits :: Word32
}
data ScreenBufferFormatPropertiesQNX = ScreenBufferFormatPropertiesQNX {
}
data ExternalFormatQNX = ExternalFormatQNX {
- externalFormat :: Word64
}
data PhysicalDeviceExternalMemoryScreenBufferFeaturesQNX = PhysicalDeviceExternalMemoryScreenBufferFeaturesQNX {
- screenBufferImport :: Bool
}
type QNX_EXTERNAL_MEMORY_SCREEN_BUFFER_SPEC_VERSION = 1
pattern QNX_EXTERNAL_MEMORY_SCREEN_BUFFER_SPEC_VERSION :: forall a. Integral a => a
type QNX_EXTERNAL_MEMORY_SCREEN_BUFFER_EXTENSION_NAME = "VK_QNX_external_memory_screen_buffer"
pattern QNX_EXTERNAL_MEMORY_SCREEN_BUFFER_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a
data Screen_buffer

Documentation

getScreenBufferPropertiesQNX Source #

Arguments

:: forall a io. (Extendss ScreenBufferPropertiesQNX a, PokeChain a, PeekChain a, MonadIO io)
=> Device	`device` is the logical device that will be importing `buffer`. `device` must be a valid `Device` handle
-> Ptr Screen_buffer	`buffer` is the QNX Screen buffer which will be imported. `buffer` must be a valid QNX Screen buffer `buffer` must be a valid pointer to a valid `Screen_buffer` value
-> io (ScreenBufferPropertiesQNX a)

vkGetScreenBufferPropertiesQNX - Get Properties of External Memory QNX Screen Buffers

Return Codes

Success

SUCCESS

Failure

Description

The implementation may not acquire a reference to the imported Screen buffer. Therefore, the application must ensure that the object referred to by buffer stays valid as long as the device memory to which it is imported is being used.

Valid Usage

If buffer is not NULL, QNX Screen Buffers must be supported for import, as reported by ExternalImageFormatProperties or ExternalBufferProperties

buffer is not NULL, it must be a pointer to valid QNX Screen buffer

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_IMPORT_SCREEN_BUFFER_INFO_QNX

Description

If the QNX Screen buffer has one of the formats listed in the QNX Screen Format Equivalence table, then format must have the equivalent Vulkan format listed in the table. Otherwise, format may be FORMAT_UNDEFINED, indicating the QNX Screen buffer can only be used with an external format. The formatFeatures member must include FORMAT_FEATURE_SAMPLED_IMAGE_BIT and should include FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT and FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_LINEAR_FILTER_BIT.

Valid Usage (Implicit)

Description

If externalFormat is zero, the effect is as if the ExternalFormatQNX structure was not present. Otherwise, the image will have the specified external format.

Valid Usage (Implicit)

Members

The members of the PhysicalDeviceExternalMemoryScreenBufferFeaturesQNX structure describe the following features:

Description

'

Features	Functionality
`screenBufferImport`	`ImportScreenBufferInfoQNX`
Always supported1	`getScreenBufferPropertiesQNX`, `ScreenBufferPropertiesQNX`, `ScreenBufferFormatPropertiesQNX`, `ExternalFormatQNX`

Functionality supported for QNX Screen Buffer features

1: Functionality in this row is always available.

The Functionality supported for QNX Screen buffer features table summarizes the functionality enabled by the PhysicalDeviceExternalMemoryScreenBufferFeaturesQNX structure. Each entry in the body of the table summarizes the functionality that can be used when the given features are supported and enabled. This summarizes Valid Usage statements that are added elsewhere in this specification.

If the PhysicalDeviceExternalMemoryScreenBufferFeaturesQNX structure is included in the pNext chain of the PhysicalDeviceFeatures2 structure passed to getPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. PhysicalDeviceExternalMemoryScreenBufferFeaturesQNX can also be used in the pNext chain of DeviceCreateInfo to selectively enable these features.

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

Extensible ScreenBufferPropertiesQNX Source #
Instance details Defined in Vulkan.Extensions.VK_QNX_external_memory_screen_buffer Methods extensibleTypeName :: String Source # getNext :: forall (es :: [Type]). ScreenBufferPropertiesQNX es -> Chain es Source # setNext :: forall (ds :: [Type]) (es :: [TYPE LiftedRep]). ScreenBufferPropertiesQNX ds -> Chain es -> ScreenBufferPropertiesQNX es Source # extends :: forall e b proxy. Typeable e => proxy e -> (Extends ScreenBufferPropertiesQNX e => b) -> Maybe b Source #
Show (Chain es) => Show (ScreenBufferPropertiesQNX es) Source #
Instance details Defined in Vulkan.Extensions.VK_QNX_external_memory_screen_buffer Methods showsPrec :: Int -> ScreenBufferPropertiesQNX es -> ShowS # show :: ScreenBufferPropertiesQNX es -> String # showList :: [ScreenBufferPropertiesQNX es] -> ShowS #
(Extendss ScreenBufferPropertiesQNX es, PeekChain es) => FromCStruct (ScreenBufferPropertiesQNX es) Source #
Instance details Defined in Vulkan.Extensions.VK_QNX_external_memory_screen_buffer Methods peekCStruct :: Ptr (ScreenBufferPropertiesQNX es) -> IO (ScreenBufferPropertiesQNX es) Source #
(Extendss ScreenBufferPropertiesQNX es, PokeChain es) => ToCStruct (ScreenBufferPropertiesQNX es) Source #
Instance details Defined in Vulkan.Extensions.VK_QNX_external_memory_screen_buffer Methods withCStruct :: ScreenBufferPropertiesQNX es -> (Ptr (ScreenBufferPropertiesQNX es) -> IO b) -> IO b Source # pokeCStruct :: Ptr (ScreenBufferPropertiesQNX es) -> ScreenBufferPropertiesQNX es -> IO b -> IO b Source # withZeroCStruct :: (Ptr (ScreenBufferPropertiesQNX es) -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr (ScreenBufferPropertiesQNX es) -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
es ~ ('[] :: [Type]) => Zero (ScreenBufferPropertiesQNX es) Source #
Instance details Defined in Vulkan.Extensions.VK_QNX_external_memory_screen_buffer Methods zero :: ScreenBufferPropertiesQNX es Source #

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

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

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

Name

VK_QNX_external_memory_screen_buffer

Other Extension Metadata

Description

New Commands

New Structures

New Enum Constants

Version History

See Also

Document Notes

Documentation

Return Codes

See Also

Description

Valid Usage

Valid Usage (Implicit)

See Also

Instances

Valid Usage (Implicit)

See Also

Instances

Description

Valid Usage (Implicit)

See Also

Instances

Description

Valid Usage (Implicit)

See Also

Instances

Members

Description

Valid Usage (Implicit)

See Also

Instances

ImportScreenBufferInfoQNX
Fields buffer :: Ptr Screen_buffer `buffer` is a pointer to a `struct` `Screen_buffer`, the QNX Screen buffer to import

ScreenBufferPropertiesQNX
Fields next :: Chain es `pNext` is `NULL` or a pointer to a structure extending this structure. allocationSize :: DeviceSize `allocationSize` is the size of the external memory. memoryTypeBits :: Word32 `memoryTypeBits` is a bitmask containing one bit set for every memory type which the specified Screen buffer can be imported as.

ExternalFormatQNX
Fields externalFormat :: Word64 `externalFormat` is an implementation-defined identifier for the external format `externalFormat` must be `0` or a value returned in the `externalFormat` member of `ScreenBufferFormatPropertiesQNX` by an earlier call to `getScreenBufferPropertiesQNX`

PhysicalDeviceExternalMemoryScreenBufferFeaturesQNX
Fields screenBufferImport :: Bool `screenBufferImport` indicates whether QNX Screen buffer import functionality is supported. If `screenBufferImport` is set to `TRUE`, `DeviceMemory` supports importing `Screen_buffer` from applications. In this case, the application is responsible for the resource management of the `Screen_buffer`.