Safe Haskell	None
Language	Haskell2010

Vulkan.Extensions.VK_NV_display_stereo

Description

Name

VK_NV_display_stereo - instance extension

VK_NV_display_stereo

Name String: VK_NV_display_stereo

Extension Type

Instance extension

Registered Extension Number

552

Revision

1

Ratification Status

Not ratified

Extension and Version Dependencies

VK_KHR_display and VK_KHR_get_display_properties2

Contact

Russell Chou @russellcnv%0A*Here describe the issue or question you have about the VK_NV_display_stereo extension*

Extension Proposal

VK_NV_display_stereo

Other Extension Metadata

Last Modified Date: 2024-11-20

Contributors

Russell Chou, NVIDIA
Jeff Juliano, NVIDIA
James Jones, NVIDIA

Description

This extension allows the application to choose which type of 3D stereo hardware it wants to use so the driver can configure it properly. This configuration is useful for swapchains created from display surfaces because some environments do not have an intermediate windowing system available for easy configuration. This extension will override any stereo type configuration in the windowing system.

For HDMI 3D, only some display modes support stereo rendering, and a new structure is needed to expose that information to the application.

New Structures

Extending DisplayModeProperties2KHR:
- DisplayModeStereoPropertiesNV

Extending DisplaySurfaceCreateInfoKHR:
- DisplaySurfaceStereoCreateInfoNV

New Enums

DisplaySurfaceStereoTypeNV

New Enum Constants

NV_DISPLAY_STEREO_EXTENSION_NAME

Version History

Revision 1, 2024-11-20 (Russell Chou)
- Initial release

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

data DisplaySurfaceStereoCreateInfoNV = DisplaySurfaceStereoCreateInfoNV {
- stereoType :: DisplaySurfaceStereoTypeNV
}
data DisplayModeStereoPropertiesNV = DisplayModeStereoPropertiesNV {
- hdmi3DSupported :: Bool
}
newtype DisplaySurfaceStereoTypeNV where
- DisplaySurfaceStereoTypeNV Int32
- pattern DISPLAY_SURFACE_STEREO_TYPE_NONE_NV :: DisplaySurfaceStereoTypeNV
- pattern DISPLAY_SURFACE_STEREO_TYPE_ONBOARD_DIN_NV :: DisplaySurfaceStereoTypeNV
- pattern DISPLAY_SURFACE_STEREO_TYPE_HDMI_3D_NV :: DisplaySurfaceStereoTypeNV
- pattern DISPLAY_SURFACE_STEREO_TYPE_INBAND_DISPLAYPORT_NV :: DisplaySurfaceStereoTypeNV
type NV_DISPLAY_STEREO_SPEC_VERSION = 1
pattern NV_DISPLAY_STEREO_SPEC_VERSION :: Integral a => a
type NV_DISPLAY_STEREO_EXTENSION_NAME = "VK_NV_display_stereo"
pattern NV_DISPLAY_STEREO_EXTENSION_NAME :: (Eq a, IsString a) => a

Documentation

data DisplaySurfaceStereoCreateInfoNV Source #

VkDisplaySurfaceStereoCreateInfoNV - Structure specifying stereo parameters of a newly created display plane surface object

Valid Usage (Implicit)

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

data DisplayModeStereoPropertiesNV Source #

VkDisplayModeStereoPropertiesNV - Structure describing the stereo properties of a display mode

Valid Usage (Implicit)

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

newtype DisplaySurfaceStereoTypeNV Source #

VkDisplaySurfaceStereoTypeNV - 3D Stereo type

Description

DISPLAY_SURFACE_STEREO_TYPE_NONE_NV specifies no configuration for stereo presentation. This is the default behavior if DisplaySurfaceStereoCreateInfoNV is not provided.

DISPLAY_SURFACE_STEREO_TYPE_ONBOARD_DIN_NV specifies configuration for glasses that connect via a DIN connector on the back of the graphics card.
DISPLAY_SURFACE_STEREO_TYPE_HDMI_3D_NV specifies configuration for HDMI 3D compatible display devices with their own stereo emitters. This is also known as HDMI Frame Packed Stereo, where the left and right eye images are stacked into a single frame with a doubled pixel clock and refresh rate.
DISPLAY_SURFACE_STEREO_TYPE_INBAND_DISPLAYPORT_NV specifies configuration for DisplayPort display devices with in-band stereo signaling and emitters.

pattern DISPLAY_SURFACE_STEREO_TYPE_NONE_NV :: DisplaySurfaceStereoTypeNV
pattern DISPLAY_SURFACE_STEREO_TYPE_ONBOARD_DIN_NV :: DisplaySurfaceStereoTypeNV
pattern DISPLAY_SURFACE_STEREO_TYPE_HDMI_3D_NV :: DisplaySurfaceStereoTypeNV
pattern DISPLAY_SURFACE_STEREO_TYPE_INBAND_DISPLAYPORT_NV :: DisplaySurfaceStereoTypeNV

Instances

Instances details

Eq DisplaySurfaceStereoTypeNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_display_stereo Methods (==) :: DisplaySurfaceStereoTypeNV -> DisplaySurfaceStereoTypeNV -> Bool # (/=) :: DisplaySurfaceStereoTypeNV -> DisplaySurfaceStereoTypeNV -> Bool #
Ord DisplaySurfaceStereoTypeNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_display_stereo Methods compare :: DisplaySurfaceStereoTypeNV -> DisplaySurfaceStereoTypeNV -> Ordering # (<) :: DisplaySurfaceStereoTypeNV -> DisplaySurfaceStereoTypeNV -> Bool # (<=) :: DisplaySurfaceStereoTypeNV -> DisplaySurfaceStereoTypeNV -> Bool # (>) :: DisplaySurfaceStereoTypeNV -> DisplaySurfaceStereoTypeNV -> Bool # (>=) :: DisplaySurfaceStereoTypeNV -> DisplaySurfaceStereoTypeNV -> Bool # max :: DisplaySurfaceStereoTypeNV -> DisplaySurfaceStereoTypeNV -> DisplaySurfaceStereoTypeNV # min :: DisplaySurfaceStereoTypeNV -> DisplaySurfaceStereoTypeNV -> DisplaySurfaceStereoTypeNV #
Storable DisplaySurfaceStereoTypeNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_display_stereo Methods sizeOf :: DisplaySurfaceStereoTypeNV -> Int # alignment :: DisplaySurfaceStereoTypeNV -> Int # peekElemOff :: Ptr DisplaySurfaceStereoTypeNV -> Int -> IO DisplaySurfaceStereoTypeNV # pokeElemOff :: Ptr DisplaySurfaceStereoTypeNV -> Int -> DisplaySurfaceStereoTypeNV -> IO () # peekByteOff :: Ptr b -> Int -> IO DisplaySurfaceStereoTypeNV # pokeByteOff :: Ptr b -> Int -> DisplaySurfaceStereoTypeNV -> IO () # peek :: Ptr DisplaySurfaceStereoTypeNV -> IO DisplaySurfaceStereoTypeNV # poke :: Ptr DisplaySurfaceStereoTypeNV -> DisplaySurfaceStereoTypeNV -> IO () #
Read DisplaySurfaceStereoTypeNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_display_stereo Methods readsPrec :: Int -> ReadS DisplaySurfaceStereoTypeNV # readList :: ReadS [DisplaySurfaceStereoTypeNV] # readPrec :: ReadPrec DisplaySurfaceStereoTypeNV # readListPrec :: ReadPrec [DisplaySurfaceStereoTypeNV] #
Show DisplaySurfaceStereoTypeNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_display_stereo Methods showsPrec :: Int -> DisplaySurfaceStereoTypeNV -> ShowS # show :: DisplaySurfaceStereoTypeNV -> String # showList :: [DisplaySurfaceStereoTypeNV] -> ShowS #
Zero DisplaySurfaceStereoTypeNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_display_stereo Methods zero :: DisplaySurfaceStereoTypeNV Source #

type NV_DISPLAY_STEREO_SPEC_VERSION = 1 Source #

pattern NV_DISPLAY_STEREO_SPEC_VERSION :: Integral a => a Source #

type NV_DISPLAY_STEREO_EXTENSION_NAME = "VK_NV_display_stereo" Source #

pattern NV_DISPLAY_STEREO_EXTENSION_NAME :: (Eq a, IsString a) => a Source #

Name

VK_NV_display_stereo

Other Extension Metadata

Description

New Structures

New Enums

New Enum Constants

Version History

See Also

Document Notes

Documentation

Valid Usage (Implicit)

See Also

Instances

Valid Usage (Implicit)

See Also

Instances

Description

See Also

Instances

DisplaySurfaceStereoCreateInfoNV
Fields stereoType :: DisplaySurfaceStereoTypeNV `stereoType` is a `DisplaySurfaceStereoTypeNV` value specifying the type of 3D stereo presentation the display will be configured for. `stereoType` must be a valid `DisplaySurfaceStereoTypeNV` value

DisplayModeStereoPropertiesNV
Fields hdmi3DSupported :: Bool `hdmi3DSupported` indicates whether this display mode can be used for a display surface configured for `DISPLAY_SURFACE_STEREO_TYPE_HDMI_3D_NV`.