Safe Haskell	None
Language	Haskell2010

Graphics.Vulkan.Extensions.VK_EXT_discard_rectangles

Synopsis

cmdSetDiscardRectangleEXT :: forall io. MonadIO io => CommandBuffer -> ("firstDiscardRectangle" ::: Word32) -> ("discardRectangles" ::: Vector Rect2D) -> io ()
data PhysicalDeviceDiscardRectanglePropertiesEXT = PhysicalDeviceDiscardRectanglePropertiesEXT {
- maxDiscardRectangles :: Word32
}
data PipelineDiscardRectangleStateCreateInfoEXT = PipelineDiscardRectangleStateCreateInfoEXT {
}
newtype PipelineDiscardRectangleStateCreateFlagsEXT = PipelineDiscardRectangleStateCreateFlagsEXT Flags
newtype DiscardRectangleModeEXT where
- DiscardRectangleModeEXT Int32
- pattern DISCARD_RECTANGLE_MODE_INCLUSIVE_EXT :: DiscardRectangleModeEXT
- pattern DISCARD_RECTANGLE_MODE_EXCLUSIVE_EXT :: 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

Documentation

cmdSetDiscardRectangleEXT :: forall io. MonadIO io => CommandBuffer -> ("firstDiscardRectangle" ::: Word32) -> ("discardRectangles" ::: Vector Rect2D) -> io () Source #

vkCmdSetDiscardRectangleEXT - Set discard rectangles dynamically

Parameters

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

firstDiscardRectangle is the index of the first discard rectangle whose state is updated by the command.
discardRectangleCount is the number of discard rectangles whose state are updated by the command.
pDiscardRectangles is a pointer to an array of Rect2D structures specifying discard rectangles.

Description

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

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

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)

Description

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

Eq PipelineDiscardRectangleStateCreateFlagsEXT Source #
Instance details Defined in Graphics.Vulkan.Extensions.VK_EXT_discard_rectangles Methods (==) :: PipelineDiscardRectangleStateCreateFlagsEXT -> PipelineDiscardRectangleStateCreateFlagsEXT -> Bool # (/=) :: PipelineDiscardRectangleStateCreateFlagsEXT -> PipelineDiscardRectangleStateCreateFlagsEXT -> Bool #
Ord PipelineDiscardRectangleStateCreateFlagsEXT Source #
Instance details Defined in Graphics.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 Source #
Instance details Defined in Graphics.Vulkan.Extensions.VK_EXT_discard_rectangles Methods readsPrec :: Int -> ReadS PipelineDiscardRectangleStateCreateFlagsEXT # readList :: ReadS [PipelineDiscardRectangleStateCreateFlagsEXT] # readPrec :: ReadPrec PipelineDiscardRectangleStateCreateFlagsEXT # readListPrec :: ReadPrec [PipelineDiscardRectangleStateCreateFlagsEXT] #
Show PipelineDiscardRectangleStateCreateFlagsEXT Source #
Instance details Defined in Graphics.Vulkan.Extensions.VK_EXT_discard_rectangles Methods showsPrec :: Int -> PipelineDiscardRectangleStateCreateFlagsEXT -> ShowS # show :: PipelineDiscardRectangleStateCreateFlagsEXT -> String # showList :: [PipelineDiscardRectangleStateCreateFlagsEXT] -> ShowS #
Storable PipelineDiscardRectangleStateCreateFlagsEXT Source #
Instance details Defined in Graphics.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 Source #
Instance details Defined in Graphics.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 Source #
Instance details Defined in Graphics.Vulkan.Extensions.VK_EXT_discard_rectangles Methods zero :: PipelineDiscardRectangleStateCreateFlagsEXT Source #

newtype DiscardRectangleModeEXT Source #

VkDiscardRectangleModeEXT - Specify the discard rectangle mode

Show PhysicalDeviceDiscardRectanglePropertiesEXT Source #
Instance details Defined in Graphics.Vulkan.Extensions.VK_EXT_discard_rectangles Methods showsPrec :: Int -> PhysicalDeviceDiscardRectanglePropertiesEXT -> ShowS # show :: PhysicalDeviceDiscardRectanglePropertiesEXT -> String # showList :: [PhysicalDeviceDiscardRectanglePropertiesEXT] -> ShowS #
Storable PhysicalDeviceDiscardRectanglePropertiesEXT Source #
Instance details Defined in Graphics.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 Source #
Instance details Defined in Graphics.Vulkan.Extensions.VK_EXT_discard_rectangles Methods peekCStruct :: Ptr PhysicalDeviceDiscardRectanglePropertiesEXT -> IO PhysicalDeviceDiscardRectanglePropertiesEXT Source #
ToCStruct PhysicalDeviceDiscardRectanglePropertiesEXT Source #
Instance details Defined in Graphics.Vulkan.Extensions.VK_EXT_discard_rectangles Methods withCStruct :: PhysicalDeviceDiscardRectanglePropertiesEXT -> (Ptr PhysicalDeviceDiscardRectanglePropertiesEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr PhysicalDeviceDiscardRectanglePropertiesEXT -> PhysicalDeviceDiscardRectanglePropertiesEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr PhysicalDeviceDiscardRectanglePropertiesEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr PhysicalDeviceDiscardRectanglePropertiesEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero PhysicalDeviceDiscardRectanglePropertiesEXT Source #
Instance details Defined in Graphics.Vulkan.Extensions.VK_EXT_discard_rectangles Methods zero :: PhysicalDeviceDiscardRectanglePropertiesEXT Source #

Show PipelineDiscardRectangleStateCreateInfoEXT Source #
Instance details Defined in Graphics.Vulkan.Extensions.VK_EXT_discard_rectangles Methods showsPrec :: Int -> PipelineDiscardRectangleStateCreateInfoEXT -> ShowS # show :: PipelineDiscardRectangleStateCreateInfoEXT -> String # showList :: [PipelineDiscardRectangleStateCreateInfoEXT] -> ShowS #
FromCStruct PipelineDiscardRectangleStateCreateInfoEXT Source #
Instance details Defined in Graphics.Vulkan.Extensions.VK_EXT_discard_rectangles Methods peekCStruct :: Ptr PipelineDiscardRectangleStateCreateInfoEXT -> IO PipelineDiscardRectangleStateCreateInfoEXT Source #
ToCStruct PipelineDiscardRectangleStateCreateInfoEXT Source #
Instance details Defined in Graphics.Vulkan.Extensions.VK_EXT_discard_rectangles Methods withCStruct :: PipelineDiscardRectangleStateCreateInfoEXT -> (Ptr PipelineDiscardRectangleStateCreateInfoEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr PipelineDiscardRectangleStateCreateInfoEXT -> PipelineDiscardRectangleStateCreateInfoEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr PipelineDiscardRectangleStateCreateInfoEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr PipelineDiscardRectangleStateCreateInfoEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero PipelineDiscardRectangleStateCreateInfoEXT Source #
Instance details Defined in Graphics.Vulkan.Extensions.VK_EXT_discard_rectangles Methods zero :: PipelineDiscardRectangleStateCreateInfoEXT Source #

Eq DiscardRectangleModeEXT Source #
Instance details Defined in Graphics.Vulkan.Extensions.VK_EXT_discard_rectangles Methods (==) :: DiscardRectangleModeEXT -> DiscardRectangleModeEXT -> Bool # (/=) :: DiscardRectangleModeEXT -> DiscardRectangleModeEXT -> Bool #
Ord DiscardRectangleModeEXT Source #
Instance details Defined in Graphics.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 Source #
Instance details Defined in Graphics.Vulkan.Extensions.VK_EXT_discard_rectangles Methods readsPrec :: Int -> ReadS DiscardRectangleModeEXT # readList :: ReadS [DiscardRectangleModeEXT] # readPrec :: ReadPrec DiscardRectangleModeEXT # readListPrec :: ReadPrec [DiscardRectangleModeEXT] #
Show DiscardRectangleModeEXT Source #
Instance details Defined in Graphics.Vulkan.Extensions.VK_EXT_discard_rectangles Methods showsPrec :: Int -> DiscardRectangleModeEXT -> ShowS # show :: DiscardRectangleModeEXT -> String # showList :: [DiscardRectangleModeEXT] -> ShowS #
Storable DiscardRectangleModeEXT Source #
Instance details Defined in Graphics.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 Source #
Instance details Defined in Graphics.Vulkan.Extensions.VK_EXT_discard_rectangles Methods zero :: DiscardRectangleModeEXT Source #

Documentation

Parameters

Description

Valid Usage

Valid Usage (Implicit)

Host Synchronization

Command Properties

See Also

Members

Description

Valid Usage (Implicit)

See Also

Valid Usage (Implicit)

See Also

Description

See Also

See Also

PhysicalDeviceDiscardRectanglePropertiesEXT
Fields maxDiscardRectangles :: Word32 `maxDiscardRectangles` is the maximum number of active discard rectangles that can be specified.

pattern DISCARD_RECTANGLE_MODE_INCLUSIVE_EXT :: DiscardRectangleModeEXT	`DISCARD_RECTANGLE_MODE_INCLUSIVE_EXT` specifies that a fragment within any discard rectangle satisfies the test.
pattern DISCARD_RECTANGLE_MODE_EXCLUSIVE_EXT :: DiscardRectangleModeEXT	`DISCARD_RECTANGLE_MODE_EXCLUSIVE_EXT` specifies that a fragment not within any of the discard rectangles satisfies the test.