Vulkan.Extensions.VK_NV_scissor_exclusive

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 the dynamic exclusive scissor rectangles on 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 state for a given draw when the graphics pipeline is created with DYNAMIC_STATE_EXCLUSIVE_SCISSOR_NV set in PipelineDynamicStateCreateInfo::pDynamicStates.

Valid Usage

• The exclusive scissor feature must be enabled

• firstExclusiveScissor must be less than PhysicalDeviceLimits::maxViewports
• 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	Pipeline Type
Primary Secondary	Both	Graphics

See Also

CommandBuffer, Rect2D

data PhysicalDeviceExclusiveScissorFeaturesNV

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

Members

The members of the PhysicalDeviceExclusiveScissorFeaturesNV structure describe the following features:

Description

See Exclusive Scissor Test for more information.

If the PhysicalDeviceExclusiveScissorFeaturesNV structure is included in the pNext chain of PhysicalDeviceFeatures2, it is filled with values indicating whether the feature is supported. PhysicalDeviceExclusiveScissorFeaturesNV can also be included in the pNext chain of DeviceCreateInfo to enable the feature.

Valid Usage (Implicit)

See Also

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

Generic PhysicalDeviceExclusiveScissorFeaturesNV

Defined in Vulkan.Extensions.VK_NV_scissor_exclusive

Associated Types

type Rep PhysicalDeviceExclusiveScissorFeaturesNV :: Type -> Type

Methods

from :: PhysicalDeviceExclusiveScissorFeaturesNV -> Rep PhysicalDeviceExclusiveScissorFeaturesNV x

to :: Rep PhysicalDeviceExclusiveScissorFeaturesNV x -> PhysicalDeviceExclusiveScissorFeaturesNV

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

type Rep PhysicalDeviceExclusiveScissorFeaturesNV

Defined in Vulkan.Extensions.VK_NV_scissor_exclusive

type Rep PhysicalDeviceExclusiveScissorFeaturesNV = D1 ('MetaData "PhysicalDeviceExclusiveScissorFeaturesNV" "Vulkan.Extensions.VK_NV_scissor_exclusive" "vulkan-3.4-inplace" 'False) (C1 ('MetaCons "PhysicalDeviceExclusiveScissorFeaturesNV" 'PrefixI 'True) (S1 ('MetaSel ('Just "exclusiveScissor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))

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 identical to the viewportCount member of PipelineViewportStateCreateInfo

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_VIEWPORT_EXCLUSIVE_SCISSOR_STATE_CREATE_INFO_NV

See Also

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

Generic PipelineViewportExclusiveScissorStateCreateInfoNV

Defined in Vulkan.Extensions.VK_NV_scissor_exclusive

Associated Types

type Rep PipelineViewportExclusiveScissorStateCreateInfoNV :: Type -> Type

Methods

from :: PipelineViewportExclusiveScissorStateCreateInfoNV -> Rep PipelineViewportExclusiveScissorStateCreateInfoNV x

to :: Rep PipelineViewportExclusiveScissorStateCreateInfoNV x -> PipelineViewportExclusiveScissorStateCreateInfoNV

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 Rep PipelineViewportExclusiveScissorStateCreateInfoNV

Defined in Vulkan.Extensions.VK_NV_scissor_exclusive

type Rep PipelineViewportExclusiveScissorStateCreateInfoNV = D1 ('MetaData "PipelineViewportExclusiveScissorStateCreateInfoNV" "Vulkan.Extensions.VK_NV_scissor_exclusive" "vulkan-3.4-inplace" 'False) (C1 ('MetaCons "PipelineViewportExclusiveScissorStateCreateInfoNV" 'PrefixI 'True) (S1 ('MetaSel ('Just "exclusiveScissors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Vector Rect2D))))

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