Vulkan.Extensions.VK_EXT_discard_rectangles

Documentation

cmdSetDiscardRectangleEXT

Arguments

:: forall io. MonadIO io

=> CommandBuffer

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

-> ("firstDiscardRectangle" ::: Word32)

firstDiscardRectangle is the index of the first discard rectangle whose state is updated by the command.

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

pDiscardRectangles is a pointer to an array of Rect2D structures specifying discard rectangles.

-> io ()

vkCmdSetDiscardRectangleEXT - Set discard rectangles dynamically

Description

The discard rectangle taken from element i of pDiscardRectangles replace the current state for the discard rectangle at index firstDiscardRectangle + i, for i in [0, discardRectangleCount).

This command sets the state for a given draw when the graphics pipeline is created with DYNAMIC_STATE_DISCARD_RECTANGLE_EXT set in PipelineDynamicStateCreateInfo::pDynamicStates.

Valid Usage

• The sum of firstDiscardRectangle and discardRectangleCount must be less than or equal to PhysicalDeviceDiscardRectanglePropertiesEXT::maxDiscardRectangles

• The x and y member of offset in each Rect2D element of pDiscardRectangles must be greater than or equal to 0
• Evaluation of (offset.x + extent.width) in each Rect2D element of pDiscardRectangles must not cause a signed integer addition overflow
• Evaluation of (offset.y + extent.height) in each Rect2D element of pDiscardRectangles must not cause a signed integer addition overflow

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pDiscardRectangles must be a valid pointer to an array of discardRectangleCount Rect2D structures
• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support graphics operations
• discardRectangleCount 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 PhysicalDeviceDiscardRectanglePropertiesEXT

VkPhysicalDeviceDiscardRectanglePropertiesEXT - Structure describing discard rectangle limits that can be supported by an implementation

Members

The members of the PhysicalDeviceDiscardRectanglePropertiesEXT structure describe the following implementation-dependent limits:

Description

If the PhysicalDeviceDiscardRectanglePropertiesEXT structure is included in the pNext chain of PhysicalDeviceProperties2, it is filled with the implementation-dependent limits.

Valid Usage (Implicit)

See Also

StructureType

Constructors

PhysicalDeviceDiscardRectanglePropertiesEXT

Fields

• maxDiscardRectangles :: Word32

  maxDiscardRectangles is the maximum number of active discard rectangles that can be specified.

Instances

Eq PhysicalDeviceDiscardRectanglePropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_discard_rectangles

Methods

(==) :: PhysicalDeviceDiscardRectanglePropertiesEXT -> PhysicalDeviceDiscardRectanglePropertiesEXT -> Bool

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

Show PhysicalDeviceDiscardRectanglePropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_discard_rectangles

Methods

showsPrec :: Int -> PhysicalDeviceDiscardRectanglePropertiesEXT -> ShowS

show :: PhysicalDeviceDiscardRectanglePropertiesEXT -> String

showList :: [PhysicalDeviceDiscardRectanglePropertiesEXT] -> ShowS

Generic PhysicalDeviceDiscardRectanglePropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_discard_rectangles

Associated Types

type Rep PhysicalDeviceDiscardRectanglePropertiesEXT :: Type -> Type

Methods

from :: PhysicalDeviceDiscardRectanglePropertiesEXT -> Rep PhysicalDeviceDiscardRectanglePropertiesEXT x

to :: Rep PhysicalDeviceDiscardRectanglePropertiesEXT x -> PhysicalDeviceDiscardRectanglePropertiesEXT

Storable PhysicalDeviceDiscardRectanglePropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_discard_rectangles

Methods

sizeOf :: PhysicalDeviceDiscardRectanglePropertiesEXT -> Int

alignment :: PhysicalDeviceDiscardRectanglePropertiesEXT -> Int

peekElemOff :: Ptr PhysicalDeviceDiscardRectanglePropertiesEXT -> Int -> IO PhysicalDeviceDiscardRectanglePropertiesEXT

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

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

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

peek :: Ptr PhysicalDeviceDiscardRectanglePropertiesEXT -> IO PhysicalDeviceDiscardRectanglePropertiesEXT

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

FromCStruct PhysicalDeviceDiscardRectanglePropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_discard_rectangles

Methods

peekCStruct :: Ptr PhysicalDeviceDiscardRectanglePropertiesEXT -> IO PhysicalDeviceDiscardRectanglePropertiesEXT

ToCStruct PhysicalDeviceDiscardRectanglePropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_discard_rectangles

Methods

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

pokeCStruct :: Ptr PhysicalDeviceDiscardRectanglePropertiesEXT -> PhysicalDeviceDiscardRectanglePropertiesEXT -> IO b -> IO b

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

pokeZeroCStruct :: Ptr PhysicalDeviceDiscardRectanglePropertiesEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceDiscardRectanglePropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_discard_rectangles

Methods

zero :: PhysicalDeviceDiscardRectanglePropertiesEXT

type Rep PhysicalDeviceDiscardRectanglePropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_discard_rectangles

type Rep PhysicalDeviceDiscardRectanglePropertiesEXT = D1 ('MetaData "PhysicalDeviceDiscardRectanglePropertiesEXT" "Vulkan.Extensions.VK_EXT_discard_rectangles" "vulkan-3.5-inplace" 'False) (C1 ('MetaCons "PhysicalDeviceDiscardRectanglePropertiesEXT" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxDiscardRectangles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32)))

data PipelineDiscardRectangleStateCreateInfoEXT

VkPipelineDiscardRectangleStateCreateInfoEXT - Structure specifying discard rectangle

Description

If the DYNAMIC_STATE_DISCARD_RECTANGLE_EXT dynamic state is enabled for a pipeline, the pDiscardRectangles member is ignored.

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

Valid Usage (Implicit)

See Also

DiscardRectangleModeEXT, PipelineDiscardRectangleStateCreateFlagsEXT, Rect2D, StructureType

Constructors

PipelineDiscardRectangleStateCreateInfoEXT

Fields

• flags :: PipelineDiscardRectangleStateCreateFlagsEXT

  flags is reserved for future use.

  flags must be 0

• discardRectangleMode :: DiscardRectangleModeEXT

  discardRectangleMode is a DiscardRectangleModeEXT value determining whether the discard rectangle test is inclusive or exclusive.

  discardRectangleMode must be a valid DiscardRectangleModeEXT value

• discardRectangles :: Vector Rect2D

  pDiscardRectangles is a pointer to an array of Rect2D structures defining discard rectangles.

Instances

Show PipelineDiscardRectangleStateCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_discard_rectangles

Methods

showsPrec :: Int -> PipelineDiscardRectangleStateCreateInfoEXT -> ShowS

show :: PipelineDiscardRectangleStateCreateInfoEXT -> String

showList :: [PipelineDiscardRectangleStateCreateInfoEXT] -> ShowS

Generic PipelineDiscardRectangleStateCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_discard_rectangles

Associated Types

type Rep PipelineDiscardRectangleStateCreateInfoEXT :: Type -> Type

Methods

from :: PipelineDiscardRectangleStateCreateInfoEXT -> Rep PipelineDiscardRectangleStateCreateInfoEXT x

to :: Rep PipelineDiscardRectangleStateCreateInfoEXT x -> PipelineDiscardRectangleStateCreateInfoEXT

FromCStruct PipelineDiscardRectangleStateCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_discard_rectangles

Methods

peekCStruct :: Ptr PipelineDiscardRectangleStateCreateInfoEXT -> IO PipelineDiscardRectangleStateCreateInfoEXT

ToCStruct PipelineDiscardRectangleStateCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_discard_rectangles

Methods

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

pokeCStruct :: Ptr PipelineDiscardRectangleStateCreateInfoEXT -> PipelineDiscardRectangleStateCreateInfoEXT -> IO b -> IO b

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

pokeZeroCStruct :: Ptr PipelineDiscardRectangleStateCreateInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PipelineDiscardRectangleStateCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_discard_rectangles

Methods

zero :: PipelineDiscardRectangleStateCreateInfoEXT

type Rep PipelineDiscardRectangleStateCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_discard_rectangles

type Rep PipelineDiscardRectangleStateCreateInfoEXT = D1 ('MetaData "PipelineDiscardRectangleStateCreateInfoEXT" "Vulkan.Extensions.VK_EXT_discard_rectangles" "vulkan-3.5-inplace" 'False) (C1 ('MetaCons "PipelineDiscardRectangleStateCreateInfoEXT" 'PrefixI 'True) (S1 ('MetaSel ('Just "flags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PipelineDiscardRectangleStateCreateFlagsEXT) :*: (S1 ('MetaSel ('Just "discardRectangleMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DiscardRectangleModeEXT) :*: S1 ('MetaSel ('Just "discardRectangles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Vector Rect2D)))))

newtype PipelineDiscardRectangleStateCreateFlagsEXT

VkPipelineDiscardRectangleStateCreateFlagsEXT - Reserved for future use

Description

PipelineDiscardRectangleStateCreateFlagsEXT is a bitmask type for setting a mask, but is currently reserved for future use.

See Also

PipelineDiscardRectangleStateCreateInfoEXT

Constructors

PipelineDiscardRectangleStateCreateFlagsEXT Flags

Instances

Eq PipelineDiscardRectangleStateCreateFlagsEXT

Defined in Vulkan.Extensions.VK_EXT_discard_rectangles

Methods

(==) :: PipelineDiscardRectangleStateCreateFlagsEXT -> PipelineDiscardRectangleStateCreateFlagsEXT -> Bool

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

Ord PipelineDiscardRectangleStateCreateFlagsEXT

Defined in Vulkan.Extensions.VK_EXT_discard_rectangles

Methods

compare :: PipelineDiscardRectangleStateCreateFlagsEXT -> PipelineDiscardRectangleStateCreateFlagsEXT -> Ordering

(<) :: PipelineDiscardRectangleStateCreateFlagsEXT -> PipelineDiscardRectangleStateCreateFlagsEXT -> Bool

(<=) :: PipelineDiscardRectangleStateCreateFlagsEXT -> PipelineDiscardRectangleStateCreateFlagsEXT -> Bool

(>) :: PipelineDiscardRectangleStateCreateFlagsEXT -> PipelineDiscardRectangleStateCreateFlagsEXT -> Bool

(>=) :: PipelineDiscardRectangleStateCreateFlagsEXT -> PipelineDiscardRectangleStateCreateFlagsEXT -> Bool

max :: PipelineDiscardRectangleStateCreateFlagsEXT -> PipelineDiscardRectangleStateCreateFlagsEXT -> PipelineDiscardRectangleStateCreateFlagsEXT

min :: PipelineDiscardRectangleStateCreateFlagsEXT -> PipelineDiscardRectangleStateCreateFlagsEXT -> PipelineDiscardRectangleStateCreateFlagsEXT

Read PipelineDiscardRectangleStateCreateFlagsEXT

Defined in Vulkan.Extensions.VK_EXT_discard_rectangles

Methods

readsPrec :: Int -> ReadS PipelineDiscardRectangleStateCreateFlagsEXT

readList :: ReadS [PipelineDiscardRectangleStateCreateFlagsEXT]

readPrec :: ReadPrec PipelineDiscardRectangleStateCreateFlagsEXT

readListPrec :: ReadPrec [PipelineDiscardRectangleStateCreateFlagsEXT]

Show PipelineDiscardRectangleStateCreateFlagsEXT

Defined in Vulkan.Extensions.VK_EXT_discard_rectangles

Methods

showsPrec :: Int -> PipelineDiscardRectangleStateCreateFlagsEXT -> ShowS

show :: PipelineDiscardRectangleStateCreateFlagsEXT -> String

showList :: [PipelineDiscardRectangleStateCreateFlagsEXT] -> ShowS

Storable PipelineDiscardRectangleStateCreateFlagsEXT

Defined in Vulkan.Extensions.VK_EXT_discard_rectangles

Methods

sizeOf :: PipelineDiscardRectangleStateCreateFlagsEXT -> Int

alignment :: PipelineDiscardRectangleStateCreateFlagsEXT -> Int

peekElemOff :: Ptr PipelineDiscardRectangleStateCreateFlagsEXT -> Int -> IO PipelineDiscardRectangleStateCreateFlagsEXT

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

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

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

peek :: Ptr PipelineDiscardRectangleStateCreateFlagsEXT -> IO PipelineDiscardRectangleStateCreateFlagsEXT

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

Bits PipelineDiscardRectangleStateCreateFlagsEXT

Defined in Vulkan.Extensions.VK_EXT_discard_rectangles

Methods

(.&.) :: PipelineDiscardRectangleStateCreateFlagsEXT -> PipelineDiscardRectangleStateCreateFlagsEXT -> PipelineDiscardRectangleStateCreateFlagsEXT

(.|.) :: PipelineDiscardRectangleStateCreateFlagsEXT -> PipelineDiscardRectangleStateCreateFlagsEXT -> PipelineDiscardRectangleStateCreateFlagsEXT

xor :: PipelineDiscardRectangleStateCreateFlagsEXT -> PipelineDiscardRectangleStateCreateFlagsEXT -> PipelineDiscardRectangleStateCreateFlagsEXT

complement :: PipelineDiscardRectangleStateCreateFlagsEXT -> PipelineDiscardRectangleStateCreateFlagsEXT

shift :: PipelineDiscardRectangleStateCreateFlagsEXT -> Int -> PipelineDiscardRectangleStateCreateFlagsEXT

rotate :: PipelineDiscardRectangleStateCreateFlagsEXT -> Int -> PipelineDiscardRectangleStateCreateFlagsEXT

zeroBits :: PipelineDiscardRectangleStateCreateFlagsEXT

bit :: Int -> PipelineDiscardRectangleStateCreateFlagsEXT

setBit :: PipelineDiscardRectangleStateCreateFlagsEXT -> Int -> PipelineDiscardRectangleStateCreateFlagsEXT

clearBit :: PipelineDiscardRectangleStateCreateFlagsEXT -> Int -> PipelineDiscardRectangleStateCreateFlagsEXT

complementBit :: PipelineDiscardRectangleStateCreateFlagsEXT -> Int -> PipelineDiscardRectangleStateCreateFlagsEXT

testBit :: PipelineDiscardRectangleStateCreateFlagsEXT -> Int -> Bool

bitSizeMaybe :: PipelineDiscardRectangleStateCreateFlagsEXT -> Maybe Int

bitSize :: PipelineDiscardRectangleStateCreateFlagsEXT -> Int

isSigned :: PipelineDiscardRectangleStateCreateFlagsEXT -> Bool

shiftL :: PipelineDiscardRectangleStateCreateFlagsEXT -> Int -> PipelineDiscardRectangleStateCreateFlagsEXT

unsafeShiftL :: PipelineDiscardRectangleStateCreateFlagsEXT -> Int -> PipelineDiscardRectangleStateCreateFlagsEXT

shiftR :: PipelineDiscardRectangleStateCreateFlagsEXT -> Int -> PipelineDiscardRectangleStateCreateFlagsEXT

unsafeShiftR :: PipelineDiscardRectangleStateCreateFlagsEXT -> Int -> PipelineDiscardRectangleStateCreateFlagsEXT

rotateL :: PipelineDiscardRectangleStateCreateFlagsEXT -> Int -> PipelineDiscardRectangleStateCreateFlagsEXT

rotateR :: PipelineDiscardRectangleStateCreateFlagsEXT -> Int -> PipelineDiscardRectangleStateCreateFlagsEXT

popCount :: PipelineDiscardRectangleStateCreateFlagsEXT -> Int

Zero PipelineDiscardRectangleStateCreateFlagsEXT

Defined in Vulkan.Extensions.VK_EXT_discard_rectangles

Methods

zero :: PipelineDiscardRectangleStateCreateFlagsEXT

newtype DiscardRectangleModeEXT

VkDiscardRectangleModeEXT - Specify the discard rectangle mode

See Also

PipelineDiscardRectangleStateCreateInfoEXT

Constructors

DiscardRectangleModeEXT Int32

Bundled Patterns

pattern DISCARD_RECTANGLE_MODE_INCLUSIVE_EXT :: DiscardRectangleModeEXT

DISCARD_RECTANGLE_MODE_INCLUSIVE_EXT specifies that the discard rectangle test is inclusive.

pattern DISCARD_RECTANGLE_MODE_EXCLUSIVE_EXT :: DiscardRectangleModeEXT

DISCARD_RECTANGLE_MODE_EXCLUSIVE_EXT specifies that the discard rectangle test is exclusive.

Instances

Eq DiscardRectangleModeEXT

Defined in Vulkan.Extensions.VK_EXT_discard_rectangles

Methods

(==) :: DiscardRectangleModeEXT -> DiscardRectangleModeEXT -> Bool

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

Ord DiscardRectangleModeEXT

Defined in Vulkan.Extensions.VK_EXT_discard_rectangles

Methods

compare :: DiscardRectangleModeEXT -> DiscardRectangleModeEXT -> Ordering

(<) :: DiscardRectangleModeEXT -> DiscardRectangleModeEXT -> Bool

(<=) :: DiscardRectangleModeEXT -> DiscardRectangleModeEXT -> Bool

(>) :: DiscardRectangleModeEXT -> DiscardRectangleModeEXT -> Bool

(>=) :: DiscardRectangleModeEXT -> DiscardRectangleModeEXT -> Bool

max :: DiscardRectangleModeEXT -> DiscardRectangleModeEXT -> DiscardRectangleModeEXT

min :: DiscardRectangleModeEXT -> DiscardRectangleModeEXT -> DiscardRectangleModeEXT

Read DiscardRectangleModeEXT

Defined in Vulkan.Extensions.VK_EXT_discard_rectangles

Methods

readsPrec :: Int -> ReadS DiscardRectangleModeEXT

readList :: ReadS [DiscardRectangleModeEXT]

readPrec :: ReadPrec DiscardRectangleModeEXT

readListPrec :: ReadPrec [DiscardRectangleModeEXT]

Show DiscardRectangleModeEXT

Defined in Vulkan.Extensions.VK_EXT_discard_rectangles

Methods

showsPrec :: Int -> DiscardRectangleModeEXT -> ShowS

show :: DiscardRectangleModeEXT -> String

showList :: [DiscardRectangleModeEXT] -> ShowS

Storable DiscardRectangleModeEXT

Defined in Vulkan.Extensions.VK_EXT_discard_rectangles

Methods

sizeOf :: DiscardRectangleModeEXT -> Int

alignment :: DiscardRectangleModeEXT -> Int

peekElemOff :: Ptr DiscardRectangleModeEXT -> Int -> IO DiscardRectangleModeEXT

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

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

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

peek :: Ptr DiscardRectangleModeEXT -> IO DiscardRectangleModeEXT

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

Zero DiscardRectangleModeEXT

Defined in Vulkan.Extensions.VK_EXT_discard_rectangles

Methods

zero :: DiscardRectangleModeEXT

type EXT_DISCARD_RECTANGLES_SPEC_VERSION = 1

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

type EXT_DISCARD_RECTANGLES_EXTENSION_NAME = "VK_EXT_discard_rectangles"

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