Vulkan.Extensions.VK_NV_scissor_exclusive

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 drawing using shader objects, or 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 exclusiveScissor feature must be enabled

• The sum of firstExclusiveScissor and exclusiveScissorCount must be between 1 and PhysicalDeviceLimits::maxViewports, inclusive

• If the multiViewport feature is not enabled, firstExclusiveScissor must be 0

• If the multiViewport 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 QUEUE_GRAPHICS_BIT operations

• This command must only be called outside of a video coding scope

• 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

'

Conditional Rendering

vkCmdSetExclusiveScissorNV is not affected by conditional rendering

See Also

VK_NV_scissor_exclusive, CommandBuffer, Rect2D

vkCmdSetExclusiveScissorEnableNV - Dynamically enable each exclusive scissor for a command buffer

Description

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

This command sets the exclusive scissor enable for subsequent drawing commands when drawing using shader objects, or when the graphics pipeline is created with DYNAMIC_STATE_EXCLUSIVE_SCISSOR_ENABLE_NV set in PipelineDynamicStateCreateInfo::pDynamicStates. Otherwise, this state is implied by the PipelineViewportExclusiveScissorStateCreateInfoNV::exclusiveScissorCount value used to create the currently active pipeline, where all exclusiveScissorCount exclusive scissors are implicitly enabled and the remainder up to PhysicalDeviceLimits::maxViewports are implicitly disabled.

Valid Usage

• The exclusiveScissor feature must be enabled, and the implementation must support at least specVersion 2 of the VK_NV_scissor_exclusive extension

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pExclusiveScissorEnables must be a valid pointer to an array of exclusiveScissorCount Bool32 values

• commandBuffer must be in the recording state

• The CommandPool that commandBuffer was allocated from must support QUEUE_GRAPHICS_BIT operations

• This command must only be called outside of a video coding scope

• 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

'

Conditional Rendering

vkCmdSetExclusiveScissorEnableNV is not affected by conditional rendering

See Also

VK_NV_scissor_exclusive, Bool32, CommandBuffer

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. If the application wishes to use a Device with any features described by PhysicalDeviceExclusiveScissorFeaturesNV, it must add an instance of the structure, with the desired feature members set to TRUE, to the pNext chain of DeviceCreateInfo when creating the Device.

Structure Chaining

Extends the structures

• DeviceCreateInfo

• PhysicalDeviceFeatures2

See Also

VK_NV_scissor_exclusive, Bool32, StructureType

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 an exclusiveScissorCount of 0.

Valid Usage

• If the multiViewport 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

Structure Chaining

Extends the structure

• PipelineViewportStateCreateInfo

See Also

VK_NV_scissor_exclusive, Rect2D, StructureType