public Class NVScissorExclusive

Extends VkDynamicState.

Enum values:

• DYNAMIC_STATE_EXCLUSIVE_SCISSOR_ENABLE_NV
• DYNAMIC_STATE_EXCLUSIVE_SCISSOR_NV

Extends VkDynamicState.

Enum values:

• DYNAMIC_STATE_EXCLUSIVE_SCISSOR_ENABLE_NV
• DYNAMIC_STATE_EXCLUSIVE_SCISSOR_NV

The extension name.

The extension specification version.

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PIPELINE_VIEWPORT_EXCLUSIVE_SCISSOR_STATE_CREATE_INFO_NV
• STRUCTURE_TYPE_PHYSICAL_DEVICE_EXCLUSIVE_SCISSOR_FEATURES_NV

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PIPELINE_VIEWPORT_EXCLUSIVE_SCISSOR_STATE_CREATE_INFO_NV
• STRUCTURE_TYPE_PHYSICAL_DEVICE_EXCLUSIVE_SCISSOR_FEATURES_NV

Unsafe version of: CmdSetExclusiveScissorEnableNV

Parameters

exclusiveScissorCount:int

the number of exclusive scissor rectangles updated by the command.

Unsafe version of: CmdSetExclusiveScissorNV

Parameters

exclusiveScissorCount:int

the number of exclusive scissor rectangles updated by the command.

Dynamically enable each exclusive scissor for a command buffer.

C Specification

To dynamically set whether an exclusive scissor is enabled or not, call:

void vkCmdSetExclusiveScissorEnableNV(
    VkCommandBuffer                             commandBuffer,
    uint32_t                                    firstExclusiveScissor,
    uint32_t                                    exclusiveScissorCount,
    const VkBool32*                             pExclusiveScissorEnables);

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 VkPipelineDynamicStateCreateInfo::pDynamicStates. Otherwise, this state is implied by the VkPipelineViewportExclusiveScissorStateCreateInfoNV::exclusiveScissorCount value used to create the currently active pipeline, where all exclusiveScissorCount exclusive scissors are implicitly enabled and the remainder up to VkPhysicalDeviceLimits::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 VkCommandBuffer handle
• pExclusiveScissorEnables must be a valid pointer to an array of exclusiveScissorCount VkBool32 values
• commandBuffer must be in the recording state
• The VkCommandPool that commandBuffer was allocated from must support graphics 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 VkCommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

Parameters

commandBuffer:VkCommandBuffer

the command buffer into which the command will be recorded.

firstExclusiveScissor:int

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

pExclusiveScissorEnables:IntBuffer

a pointer to an array of VkBool32 values defining whether the exclusive scissor is enabled.

Array version of: CmdSetExclusiveScissorEnableNV

Set exclusive scissor rectangles dynamically for a command buffer.

C Specification

To dynamically set the exclusive scissor rectangles, call:

void vkCmdSetExclusiveScissorNV(
    VkCommandBuffer                             commandBuffer,
    uint32_t                                    firstExclusiveScissor,
    uint32_t                                    exclusiveScissorCount,
    const VkRect2D*                             pExclusiveScissors);

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 VkPipelineDynamicStateCreateInfo::pDynamicStates. Otherwise, this state is specified by the VkPipelineViewportExclusiveScissorStateCreateInfoNV::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 VkPhysicalDeviceLimits::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 VkCommandBuffer handle
• pExclusiveScissors must be a valid pointer to an array of exclusiveScissorCount VkRect2D structures
• commandBuffer must be in the recording state
• The VkCommandPool that commandBuffer was allocated from must support graphics 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 VkCommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

See Also

VkRect2D

Parameters

commandBuffer:VkCommandBuffer

the command buffer into which the command will be recorded.

firstExclusiveScissor:int

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

pExclusiveScissors:VkRect2D.Buffer

a pointer to an array of VkRect2D structures defining exclusive scissor rectangles.