Graphics.Vulkan.Extensions.VK_NV_clip_space_w_scaling

Documentation

pattern VK_DYNAMIC_STATE_VIEWPORT_W_SCALING_NV :: VkDynamicState

VK_DYNAMIC_STATE_VIEWPORT_W_SCALING_NV specifies that the pViewportScalings state in VkPipelineViewportWScalingStateCreateInfoNV will be ignored and must be set dynamically with vkCmdSetViewportWScalingNV before any draws are performed with a pipeline state with VkPipelineViewportWScalingStateCreateInfo member viewportScalingEnable set to VK_TRUE

pattern VK_STRUCTURE_TYPE_PIPELINE_VIEWPORT_W_SCALING_STATE_CREATE_INFO_NV :: VkStructureType

pattern VK_NV_CLIP_SPACE_W_SCALING_SPEC_VERSION :: Integral a => a

pattern VK_NV_CLIP_SPACE_W_SCALING_EXTENSION_NAME :: (Eq a, IsString a) => a

vkCmdSetViewportWScalingNV :: ("commandBuffer" ::: VkCommandBuffer) -> ("firstViewport" ::: Word32) -> ("viewportCount" ::: Word32) -> ("pViewportWScalings" ::: Ptr VkViewportWScalingNV) -> IO ()

vkCmdSetViewportWScalingNV - Set the viewport W scaling on a command buffer

Parameters

• commandBuffer is the command buffer into which the command will be recorded.

• firstViewport is the index of the first viewport whose parameters are updated by the command.
• viewportCount is the number of viewports whose parameters are updated by the command.
• pViewportWScalings is a pointer to an array of VkViewportWScalingNV structures specifying viewport parameters.

Description

The viewport parameters taken from element i of pViewportWScalings replace the current state for the viewport index firstViewport + i, for i in [0, viewportCount).

Valid Usage

• The bound graphics pipeline must have been created with the VK_DYNAMIC_STATE_VIEWPORT_W_SCALING_NV dynamic state enabled

• firstViewport must be less than VkPhysicalDeviceLimits::maxViewports
• The sum of firstViewport and viewportCount must be between 1 and VkPhysicalDeviceLimits::maxViewports, inclusive

Valid Usage (Implicit)

• commandBuffer must be a valid VkCommandBuffer handle

• pViewportWScalings must be a valid pointer to an array of viewportCount VkViewportWScalingNV structures
• commandBuffer must be in the recording state
• The VkCommandPool that commandBuffer was allocated from must support graphics operations
• viewportCount must be greater than 0

Host Synchronization

• Host access to commandBuffer must be externally synchronized

• Host access to the VkCommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

+-----------------+-----------------+-----------------+-----------------+
| <#VkCommandBuff | <#vkCmdBeginRen | <#VkQueueFlagBi | <#synchronizati |
| erLevel Command | derPass Render  | ts Supported Qu | on-pipeline-sta |
|  Buffer Levels> | Pass Scope>     | eue Types>      | ges-types Pipel |
|                 |                 |                 | ine Type>       |
+=================+=================+=================+=================+
| Primary         | Both            | Graphics        |                 |
| Secondary       |                 |                 |                 |
+-----------------+-----------------+-----------------+-----------------+

See Also

VkCommandBuffer, VkViewportWScalingNV

data VkViewportWScalingNV

VkViewportWScalingNV - Structure specifying a viewport

Description

See Also

VkPipelineViewportWScalingStateCreateInfoNV, vkCmdSetViewportWScalingNV

Constructors

VkViewportWScalingNV

Fields

• vkXcoeff :: CFloat

  xcoeff and ycoeff are the viewport’s W scaling factor for x and y respectively.

• vkYcoeff :: CFloat

Instances

Eq VkViewportWScalingNV

Methods

(==) :: VkViewportWScalingNV -> VkViewportWScalingNV -> Bool

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

Show VkViewportWScalingNV

Methods

showsPrec :: Int -> VkViewportWScalingNV -> ShowS

show :: VkViewportWScalingNV -> String

showList :: [VkViewportWScalingNV] -> ShowS

Storable VkViewportWScalingNV

Methods

sizeOf :: VkViewportWScalingNV -> Int

alignment :: VkViewportWScalingNV -> Int

peekElemOff :: Ptr VkViewportWScalingNV -> Int -> IO VkViewportWScalingNV

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

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

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

peek :: Ptr VkViewportWScalingNV -> IO VkViewportWScalingNV

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

data VkPipelineViewportWScalingStateCreateInfoNV

VkPipelineViewportWScalingStateCreateInfoNV - Structure specifying parameters of a newly created pipeline viewport W scaling state

Description

Valid Usage (Implicit)

• sType must be VK_STRUCTURE_TYPE_PIPELINE_VIEWPORT_W_SCALING_STATE_CREATE_INFO_NV

• viewportCount must be greater than 0

See Also

VkBool32, VkStructureType, VkViewportWScalingNV

Constructors

VkPipelineViewportWScalingStateCreateInfoNV

Fields

• vkSType :: VkStructureType

  sType is the type of this structure.

• vkPNext :: Ptr ()

  pNext is NULL or a pointer to an extension-specific structure.

• vkViewportWScalingEnable :: VkBool32

  viewportWScalingEnable controls whether viewport W scaling is enabled.

• vkViewportCount :: Word32

  viewportCount is the number of viewports used by W scaling, and must match the number of viewports in the pipeline if viewport W scaling is enabled.

• vkPViewportWScalings :: Ptr VkViewportWScalingNV

  pViewportWScalings is a pointer to an array of VkViewportWScalingNV structures, which define the W scaling parameters for the corresponding viewport. If the viewport W scaling state is dynamic, this member is ignored.

Instances

Eq VkPipelineViewportWScalingStateCreateInfoNV

Methods

(==) :: VkPipelineViewportWScalingStateCreateInfoNV -> VkPipelineViewportWScalingStateCreateInfoNV -> Bool

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

Show VkPipelineViewportWScalingStateCreateInfoNV

Methods

showsPrec :: Int -> VkPipelineViewportWScalingStateCreateInfoNV -> ShowS

show :: VkPipelineViewportWScalingStateCreateInfoNV -> String

showList :: [VkPipelineViewportWScalingStateCreateInfoNV] -> ShowS

Storable VkPipelineViewportWScalingStateCreateInfoNV

Methods

sizeOf :: VkPipelineViewportWScalingStateCreateInfoNV -> Int

alignment :: VkPipelineViewportWScalingStateCreateInfoNV -> Int

peekElemOff :: Ptr VkPipelineViewportWScalingStateCreateInfoNV -> Int -> IO VkPipelineViewportWScalingStateCreateInfoNV

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

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

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

peek :: Ptr VkPipelineViewportWScalingStateCreateInfoNV -> IO VkPipelineViewportWScalingStateCreateInfoNV

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