Vulkan.Extensions.VK_NV_scissor_exclusive

Name

VK_NV_scissor_exclusive - device extension

VK_NV_scissor_exclusive

Name String

VK_NV_scissor_exclusive

Extension Type

Device extension

Registered Extension Number

206

Revision

1

Extension and Version Dependencies

• Requires Vulkan 1.0
• Requires VK_KHR_get_physical_device_properties2

Contact

• Pat Brown @nvpbrown%0A<<Here describe the issue or question you have about the VK_NV_scissor_exclusive extension> >

Other Extension Metadata

Last Modified Date

2018-07-31

IP Status

No known IP claims.

Interactions and External Dependencies

None

Contributors

• Pat Brown, NVIDIA
• Jeff Bolz, NVIDIA
• Piers Daniell, NVIDIA
• Daniel Koch, NVIDIA

Description

This extension adds support for an exclusive scissor test to Vulkan. The exclusive scissor test behaves like the scissor test, except that the exclusive scissor test fails for pixels inside the corresponding rectangle and passes for pixels outside the rectangle. If the same rectangle is used for both the scissor and exclusive scissor tests, the exclusive scissor test will pass if and only if the scissor test fails.

New Commands

• cmdSetExclusiveScissorNV

New Structures

• Extending PhysicalDeviceFeatures2, DeviceCreateInfo:

  • PhysicalDeviceExclusiveScissorFeaturesNV

• Extending PipelineViewportStateCreateInfo:

  • PipelineViewportExclusiveScissorStateCreateInfoNV

New Enum Constants

• NV_SCISSOR_EXCLUSIVE_EXTENSION_NAME

• NV_SCISSOR_EXCLUSIVE_SPEC_VERSION

• Extending DynamicState:

  • DYNAMIC_STATE_EXCLUSIVE_SCISSOR_NV

• Extending StructureType:

  • STRUCTURE_TYPE_PHYSICAL_DEVICE_EXCLUSIVE_SCISSOR_FEATURES_NV
  • STRUCTURE_TYPE_PIPELINE_VIEWPORT_EXCLUSIVE_SCISSOR_STATE_CREATE_INFO_NV

Issues

1) For the scissor test, the viewport state must be created with a matching number of scissor and viewport rectangles. Should we have the same requirement for exclusive scissors?

RESOLVED: For exclusive scissors, we relax this requirement and allow an exclusive scissor rectangle count that is either zero or equal to the number of viewport rectangles. If you pass in an exclusive scissor count of zero, the exclusive scissor test is treated as disabled.

Version History

• Revision 1, 2018-07-31 (Pat Brown)

  • Internal revisions

See Also

PhysicalDeviceExclusiveScissorFeaturesNV, PipelineViewportExclusiveScissorStateCreateInfoNV, cmdSetExclusiveScissorNV

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.

Documentation

cmdSetExclusiveScissorNV

Arguments

:: forall io. MonadIO io

=> CommandBuffer

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

-> ("firstExclusiveScissor" ::: Word32)

firstExclusiveScissor is the index of the first exclusive scissor rectangle whose state is updated by the command.

-> ("exclusiveScissors" ::: Vector Rect2D)

pExclusiveScissors is a pointer to an array of Rect2D structures defining exclusive scissor rectangles.

-> io ()

vkCmdSetExclusiveScissorNV - Set exclusive scissor rectangles dynamically for a command buffer

Description

The scissor rectangles taken from element i of pExclusiveScissors replace the current state for the scissor index firstExclusiveScissor + i, for i in [0, exclusiveScissorCount).

This command sets the exclusive scissor rectangles for subsequent drawing commands when the graphics pipeline is created with DYNAMIC_STATE_EXCLUSIVE_SCISSOR_NV set in PipelineDynamicStateCreateInfo::pDynamicStates. Otherwise, this state is specified by the PipelineViewportExclusiveScissorStateCreateInfoNV::pExclusiveScissors values used to create the currently active pipeline.

Valid Usage

• The exclusive scissor feature must be enabled

• The sum of firstExclusiveScissor and exclusiveScissorCount must be between 1 and PhysicalDeviceLimits::maxViewports, inclusive
• If the multiple viewports feature is not enabled, firstExclusiveScissor must be 0
• If the multiple viewports feature is not enabled, exclusiveScissorCount must be 1
• The x and y members of offset in each member of pExclusiveScissors must be greater than or equal to 0
• Evaluation of (offset.x + extent.width) for each member of pExclusiveScissors must not cause a signed integer addition overflow
• Evaluation of (offset.y + extent.height) for each member of pExclusiveScissors must not cause a signed integer addition overflow

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pExclusiveScissors must be a valid pointer to an array of exclusiveScissorCount Rect2D structures
• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support graphics operations
• exclusiveScissorCount must be greater than 0

Host Synchronization

• Host access to commandBuffer must be externally synchronized

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

Command Properties

'

Command Buffer Levels	Render Pass Scope	Supported Queue Types
Primary Secondary	Both	Graphics

See Also

VK_NV_scissor_exclusive, CommandBuffer, Rect2D

data PhysicalDeviceExclusiveScissorFeaturesNV

VkPhysicalDeviceExclusiveScissorFeaturesNV - Structure describing exclusive scissor features that can be supported by an implementation

Members

This structure describes the following feature:

Description

See Exclusive Scissor Test for more information.

If the PhysicalDeviceExclusiveScissorFeaturesNV 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. PhysicalDeviceExclusiveScissorFeaturesNV can also be used in the pNext chain of DeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

See Also

VK_NV_scissor_exclusive, Bool32, StructureType

Constructors

PhysicalDeviceExclusiveScissorFeaturesNV

Fields

• exclusiveScissor :: Bool

  exclusiveScissor indicates that the implementation supports the exclusive scissor test.

Instances

Eq PhysicalDeviceExclusiveScissorFeaturesNV

Defined in Vulkan.Extensions.VK_NV_scissor_exclusive

Methods

(==) :: PhysicalDeviceExclusiveScissorFeaturesNV -> PhysicalDeviceExclusiveScissorFeaturesNV -> Bool

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

Show PhysicalDeviceExclusiveScissorFeaturesNV

Defined in Vulkan.Extensions.VK_NV_scissor_exclusive

Methods

showsPrec :: Int -> PhysicalDeviceExclusiveScissorFeaturesNV -> ShowS

show :: PhysicalDeviceExclusiveScissorFeaturesNV -> String

showList :: [PhysicalDeviceExclusiveScissorFeaturesNV] -> ShowS

Storable PhysicalDeviceExclusiveScissorFeaturesNV

Defined in Vulkan.Extensions.VK_NV_scissor_exclusive

Methods

sizeOf :: PhysicalDeviceExclusiveScissorFeaturesNV -> Int

alignment :: PhysicalDeviceExclusiveScissorFeaturesNV -> Int

peekElemOff :: Ptr PhysicalDeviceExclusiveScissorFeaturesNV -> Int -> IO PhysicalDeviceExclusiveScissorFeaturesNV

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

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

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

peek :: Ptr PhysicalDeviceExclusiveScissorFeaturesNV -> IO PhysicalDeviceExclusiveScissorFeaturesNV

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

FromCStruct PhysicalDeviceExclusiveScissorFeaturesNV

Defined in Vulkan.Extensions.VK_NV_scissor_exclusive

Methods

peekCStruct :: Ptr PhysicalDeviceExclusiveScissorFeaturesNV -> IO PhysicalDeviceExclusiveScissorFeaturesNV

ToCStruct PhysicalDeviceExclusiveScissorFeaturesNV

Defined in Vulkan.Extensions.VK_NV_scissor_exclusive

Methods

withCStruct :: PhysicalDeviceExclusiveScissorFeaturesNV -> (Ptr PhysicalDeviceExclusiveScissorFeaturesNV -> IO b) -> IO b

pokeCStruct :: Ptr PhysicalDeviceExclusiveScissorFeaturesNV -> PhysicalDeviceExclusiveScissorFeaturesNV -> IO b -> IO b

withZeroCStruct :: (Ptr PhysicalDeviceExclusiveScissorFeaturesNV -> IO b) -> IO b

pokeZeroCStruct :: Ptr PhysicalDeviceExclusiveScissorFeaturesNV -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceExclusiveScissorFeaturesNV

Defined in Vulkan.Extensions.VK_NV_scissor_exclusive

Methods

zero :: PhysicalDeviceExclusiveScissorFeaturesNV

data PipelineViewportExclusiveScissorStateCreateInfoNV

VkPipelineViewportExclusiveScissorStateCreateInfoNV - Structure specifying parameters controlling exclusive scissor testing

Description

If the DYNAMIC_STATE_EXCLUSIVE_SCISSOR_NV dynamic state is enabled for a pipeline, the pExclusiveScissors member is ignored.

When this structure is included in the pNext chain of GraphicsPipelineCreateInfo, it defines parameters of the exclusive scissor test. If this structure is not included in the pNext chain, it is equivalent to specifying this structure with a exclusiveScissorCount of 0.

Valid Usage

• If the multiple viewports feature is not enabled, exclusiveScissorCount must be 0 or 1

• exclusiveScissorCount must be less than or equal to PhysicalDeviceLimits::maxViewports
• exclusiveScissorCount must be 0 or greater than or equal to the viewportCount member of PipelineViewportStateCreateInfo

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_VIEWPORT_EXCLUSIVE_SCISSOR_STATE_CREATE_INFO_NV

See Also

VK_NV_scissor_exclusive, Rect2D, StructureType

Constructors

PipelineViewportExclusiveScissorStateCreateInfoNV

Fields

• exclusiveScissors :: Vector Rect2D

  pExclusiveScissors is a pointer to an array of Rect2D structures defining exclusive scissor rectangles.

Instances

Show PipelineViewportExclusiveScissorStateCreateInfoNV

Defined in Vulkan.Extensions.VK_NV_scissor_exclusive

Methods

showsPrec :: Int -> PipelineViewportExclusiveScissorStateCreateInfoNV -> ShowS

show :: PipelineViewportExclusiveScissorStateCreateInfoNV -> String

showList :: [PipelineViewportExclusiveScissorStateCreateInfoNV] -> ShowS

FromCStruct PipelineViewportExclusiveScissorStateCreateInfoNV

Defined in Vulkan.Extensions.VK_NV_scissor_exclusive

Methods

peekCStruct :: Ptr PipelineViewportExclusiveScissorStateCreateInfoNV -> IO PipelineViewportExclusiveScissorStateCreateInfoNV

ToCStruct PipelineViewportExclusiveScissorStateCreateInfoNV

Defined in Vulkan.Extensions.VK_NV_scissor_exclusive

Methods

withCStruct :: PipelineViewportExclusiveScissorStateCreateInfoNV -> (Ptr PipelineViewportExclusiveScissorStateCreateInfoNV -> IO b) -> IO b

pokeCStruct :: Ptr PipelineViewportExclusiveScissorStateCreateInfoNV -> PipelineViewportExclusiveScissorStateCreateInfoNV -> IO b -> IO b

withZeroCStruct :: (Ptr PipelineViewportExclusiveScissorStateCreateInfoNV -> IO b) -> IO b

pokeZeroCStruct :: Ptr PipelineViewportExclusiveScissorStateCreateInfoNV -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PipelineViewportExclusiveScissorStateCreateInfoNV

Defined in Vulkan.Extensions.VK_NV_scissor_exclusive

Methods

zero :: PipelineViewportExclusiveScissorStateCreateInfoNV

type NV_SCISSOR_EXCLUSIVE_SPEC_VERSION = 1

pattern NV_SCISSOR_EXCLUSIVE_SPEC_VERSION :: forall a. Integral a => a

type NV_SCISSOR_EXCLUSIVE_EXTENSION_NAME = "VK_NV_scissor_exclusive"

pattern NV_SCISSOR_EXCLUSIVE_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a