Safe Haskell	None
Language	Haskell2010

Graphics.Vulkan.Extensions.VK_EXT_discard_rectangles

Synopsis

newtype VkDiscardRectangleModeEXT = VkDiscardRectangleModeEXT Int32
pattern VK_DISCARD_RECTANGLE_MODE_INCLUSIVE_EXT :: VkDiscardRectangleModeEXT
pattern VK_DISCARD_RECTANGLE_MODE_EXCLUSIVE_EXT :: VkDiscardRectangleModeEXT
newtype VkPipelineDiscardRectangleStateCreateFlagsEXT = VkPipelineDiscardRectangleStateCreateFlagsEXT VkFlags
pattern VK_DYNAMIC_STATE_DISCARD_RECTANGLE_EXT :: VkDynamicState
pattern VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_DISCARD_RECTANGLE_PROPERTIES_EXT :: VkStructureType
pattern VK_STRUCTURE_TYPE_PIPELINE_DISCARD_RECTANGLE_STATE_CREATE_INFO_EXT :: VkStructureType
pattern VK_EXT_DISCARD_RECTANGLES_SPEC_VERSION :: Integral a => a
pattern VK_EXT_DISCARD_RECTANGLES_EXTENSION_NAME :: (Eq a, IsString a) => a
vkCmdSetDiscardRectangleEXT :: ("commandBuffer" ::: VkCommandBuffer) -> ("firstDiscardRectangle" ::: Word32) -> ("discardRectangleCount" ::: Word32) -> ("pDiscardRectangles" ::: Ptr VkRect2D) -> IO ()
data VkPhysicalDeviceDiscardRectanglePropertiesEXT = VkPhysicalDeviceDiscardRectanglePropertiesEXT {
- vkSType :: VkStructureType
- vkPNext :: Ptr ()
- vkMaxDiscardRectangles :: Word32
}
data VkPipelineDiscardRectangleStateCreateInfoEXT = VkPipelineDiscardRectangleStateCreateInfoEXT {
}

Documentation

newtype VkDiscardRectangleModeEXT Source #

VkDiscardRectangleModeEXT - Specify the discard rectangle mode

Description

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

Eq VkPipelineDiscardRectangleStateCreateFlagsEXT Source #
Instance details Methods (==) :: VkPipelineDiscardRectangleStateCreateFlagsEXT -> VkPipelineDiscardRectangleStateCreateFlagsEXT -> Bool # (/=) :: VkPipelineDiscardRectangleStateCreateFlagsEXT -> VkPipelineDiscardRectangleStateCreateFlagsEXT -> Bool #
Ord VkPipelineDiscardRectangleStateCreateFlagsEXT Source #
Instance details Methods compare :: VkPipelineDiscardRectangleStateCreateFlagsEXT -> VkPipelineDiscardRectangleStateCreateFlagsEXT -> Ordering # (<) :: VkPipelineDiscardRectangleStateCreateFlagsEXT -> VkPipelineDiscardRectangleStateCreateFlagsEXT -> Bool # (<=) :: VkPipelineDiscardRectangleStateCreateFlagsEXT -> VkPipelineDiscardRectangleStateCreateFlagsEXT -> Bool # (>) :: VkPipelineDiscardRectangleStateCreateFlagsEXT -> VkPipelineDiscardRectangleStateCreateFlagsEXT -> Bool # (>=) :: VkPipelineDiscardRectangleStateCreateFlagsEXT -> VkPipelineDiscardRectangleStateCreateFlagsEXT -> Bool # max :: VkPipelineDiscardRectangleStateCreateFlagsEXT -> VkPipelineDiscardRectangleStateCreateFlagsEXT -> VkPipelineDiscardRectangleStateCreateFlagsEXT # min :: VkPipelineDiscardRectangleStateCreateFlagsEXT -> VkPipelineDiscardRectangleStateCreateFlagsEXT -> VkPipelineDiscardRectangleStateCreateFlagsEXT #
Read VkPipelineDiscardRectangleStateCreateFlagsEXT Source #
Instance details Methods readsPrec :: Int -> ReadS VkPipelineDiscardRectangleStateCreateFlagsEXT # readList :: ReadS [VkPipelineDiscardRectangleStateCreateFlagsEXT] # readPrec :: ReadPrec VkPipelineDiscardRectangleStateCreateFlagsEXT # readListPrec :: ReadPrec [VkPipelineDiscardRectangleStateCreateFlagsEXT] #
Show VkPipelineDiscardRectangleStateCreateFlagsEXT Source #
Instance details Methods showsPrec :: Int -> VkPipelineDiscardRectangleStateCreateFlagsEXT -> ShowS # show :: VkPipelineDiscardRectangleStateCreateFlagsEXT -> String # showList :: [VkPipelineDiscardRectangleStateCreateFlagsEXT] -> ShowS #
Storable VkPipelineDiscardRectangleStateCreateFlagsEXT Source #
Instance details Methods sizeOf :: VkPipelineDiscardRectangleStateCreateFlagsEXT -> Int # alignment :: VkPipelineDiscardRectangleStateCreateFlagsEXT -> Int # peekElemOff :: Ptr VkPipelineDiscardRectangleStateCreateFlagsEXT -> Int -> IO VkPipelineDiscardRectangleStateCreateFlagsEXT # pokeElemOff :: Ptr VkPipelineDiscardRectangleStateCreateFlagsEXT -> Int -> VkPipelineDiscardRectangleStateCreateFlagsEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO VkPipelineDiscardRectangleStateCreateFlagsEXT # pokeByteOff :: Ptr b -> Int -> VkPipelineDiscardRectangleStateCreateFlagsEXT -> IO () # peek :: Ptr VkPipelineDiscardRectangleStateCreateFlagsEXT -> IO VkPipelineDiscardRectangleStateCreateFlagsEXT # poke :: Ptr VkPipelineDiscardRectangleStateCreateFlagsEXT -> VkPipelineDiscardRectangleStateCreateFlagsEXT -> IO () #
Bits VkPipelineDiscardRectangleStateCreateFlagsEXT Source #
Instance details Methods (.&.) :: VkPipelineDiscardRectangleStateCreateFlagsEXT -> VkPipelineDiscardRectangleStateCreateFlagsEXT -> VkPipelineDiscardRectangleStateCreateFlagsEXT # (.\|.) :: VkPipelineDiscardRectangleStateCreateFlagsEXT -> VkPipelineDiscardRectangleStateCreateFlagsEXT -> VkPipelineDiscardRectangleStateCreateFlagsEXT # xor :: VkPipelineDiscardRectangleStateCreateFlagsEXT -> VkPipelineDiscardRectangleStateCreateFlagsEXT -> VkPipelineDiscardRectangleStateCreateFlagsEXT # complement :: VkPipelineDiscardRectangleStateCreateFlagsEXT -> VkPipelineDiscardRectangleStateCreateFlagsEXT # shift :: VkPipelineDiscardRectangleStateCreateFlagsEXT -> Int -> VkPipelineDiscardRectangleStateCreateFlagsEXT # rotate :: VkPipelineDiscardRectangleStateCreateFlagsEXT -> Int -> VkPipelineDiscardRectangleStateCreateFlagsEXT # zeroBits :: VkPipelineDiscardRectangleStateCreateFlagsEXT # bit :: Int -> VkPipelineDiscardRectangleStateCreateFlagsEXT # setBit :: VkPipelineDiscardRectangleStateCreateFlagsEXT -> Int -> VkPipelineDiscardRectangleStateCreateFlagsEXT # clearBit :: VkPipelineDiscardRectangleStateCreateFlagsEXT -> Int -> VkPipelineDiscardRectangleStateCreateFlagsEXT # complementBit :: VkPipelineDiscardRectangleStateCreateFlagsEXT -> Int -> VkPipelineDiscardRectangleStateCreateFlagsEXT # testBit :: VkPipelineDiscardRectangleStateCreateFlagsEXT -> Int -> Bool # bitSizeMaybe :: VkPipelineDiscardRectangleStateCreateFlagsEXT -> Maybe Int # bitSize :: VkPipelineDiscardRectangleStateCreateFlagsEXT -> Int # isSigned :: VkPipelineDiscardRectangleStateCreateFlagsEXT -> Bool # shiftL :: VkPipelineDiscardRectangleStateCreateFlagsEXT -> Int -> VkPipelineDiscardRectangleStateCreateFlagsEXT # unsafeShiftL :: VkPipelineDiscardRectangleStateCreateFlagsEXT -> Int -> VkPipelineDiscardRectangleStateCreateFlagsEXT # shiftR :: VkPipelineDiscardRectangleStateCreateFlagsEXT -> Int -> VkPipelineDiscardRectangleStateCreateFlagsEXT # unsafeShiftR :: VkPipelineDiscardRectangleStateCreateFlagsEXT -> Int -> VkPipelineDiscardRectangleStateCreateFlagsEXT # rotateL :: VkPipelineDiscardRectangleStateCreateFlagsEXT -> Int -> VkPipelineDiscardRectangleStateCreateFlagsEXT # rotateR :: VkPipelineDiscardRectangleStateCreateFlagsEXT -> Int -> VkPipelineDiscardRectangleStateCreateFlagsEXT # popCount :: VkPipelineDiscardRectangleStateCreateFlagsEXT -> Int #
FiniteBits VkPipelineDiscardRectangleStateCreateFlagsEXT Source #
Instance details Methods finiteBitSize :: VkPipelineDiscardRectangleStateCreateFlagsEXT -> Int # countLeadingZeros :: VkPipelineDiscardRectangleStateCreateFlagsEXT -> Int # countTrailingZeros :: VkPipelineDiscardRectangleStateCreateFlagsEXT -> Int #

pattern VK_DYNAMIC_STATE_DISCARD_RECTANGLE_EXT :: VkDynamicState Source #

pattern VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_DISCARD_RECTANGLE_PROPERTIES_EXT :: VkStructureType Source #

pattern VK_STRUCTURE_TYPE_PIPELINE_DISCARD_RECTANGLE_STATE_CREATE_INFO_EXT :: VkStructureType Source #

pattern VK_EXT_DISCARD_RECTANGLES_SPEC_VERSION :: Integral a => a Source #

pattern VK_EXT_DISCARD_RECTANGLES_EXTENSION_NAME :: (Eq a, IsString a) => a Source #

vkCmdSetDiscardRectangleEXT :: ("commandBuffer" ::: VkCommandBuffer) -> ("firstDiscardRectangle" ::: Word32) -> ("discardRectangleCount" ::: Word32) -> ("pDiscardRectangles" ::: Ptr VkRect2D) -> 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 VkRect2D 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 bound graphics pipeline must have been created with the VK_DYNAMIC_STATE_DISCARD_RECTANGLE_EXT dynamic state enabled

The sum of firstDiscardRectangle and discardRectangleCount must be less than or equal to VkPhysicalDeviceDiscardRectanglePropertiesEXT::maxDiscardRectangles
The x and y member of offset in each VkRect2D element of pDiscardRectangles must be greater than or equal to 0
Evaluation of (offset.x + extent.width) in each VkRect2D element of pDiscardRectangles must not cause a signed integer addition overflow
Evaluation of (offset.y + extent.height) in each VkRect2D element of pDiscardRectangles must not cause a signed integer addition overflow

Valid Usage (Implicit)

commandBuffer must be a valid VkCommandBuffer handle

pDiscardRectangles must be a valid pointer to an array of discardRectangleCount VkRect2D structures
commandBuffer must be in the recording state
The VkCommandPool 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 VkCommandPool 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 VkPhysicalDeviceDiscardRectanglePropertiesEXT structure describe the following implementation-dependent limits:

Description

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

Valid Usage (Implicit)

sType must be VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_DISCARD_RECTANGLE_PROPERTIES_EXT

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

Eq VkDiscardRectangleModeEXT Source #
Instance details Methods (==) :: VkDiscardRectangleModeEXT -> VkDiscardRectangleModeEXT -> Bool # (/=) :: VkDiscardRectangleModeEXT -> VkDiscardRectangleModeEXT -> Bool #
Ord VkDiscardRectangleModeEXT Source #
Instance details Methods compare :: VkDiscardRectangleModeEXT -> VkDiscardRectangleModeEXT -> Ordering # (<) :: VkDiscardRectangleModeEXT -> VkDiscardRectangleModeEXT -> Bool # (<=) :: VkDiscardRectangleModeEXT -> VkDiscardRectangleModeEXT -> Bool # (>) :: VkDiscardRectangleModeEXT -> VkDiscardRectangleModeEXT -> Bool # (>=) :: VkDiscardRectangleModeEXT -> VkDiscardRectangleModeEXT -> Bool # max :: VkDiscardRectangleModeEXT -> VkDiscardRectangleModeEXT -> VkDiscardRectangleModeEXT # min :: VkDiscardRectangleModeEXT -> VkDiscardRectangleModeEXT -> VkDiscardRectangleModeEXT #
Read VkDiscardRectangleModeEXT Source #
Instance details Methods readsPrec :: Int -> ReadS VkDiscardRectangleModeEXT # readList :: ReadS [VkDiscardRectangleModeEXT] # readPrec :: ReadPrec VkDiscardRectangleModeEXT # readListPrec :: ReadPrec [VkDiscardRectangleModeEXT] #
Show VkDiscardRectangleModeEXT Source #
Instance details Methods showsPrec :: Int -> VkDiscardRectangleModeEXT -> ShowS # show :: VkDiscardRectangleModeEXT -> String # showList :: [VkDiscardRectangleModeEXT] -> ShowS #
Storable VkDiscardRectangleModeEXT Source #
Instance details Methods sizeOf :: VkDiscardRectangleModeEXT -> Int # alignment :: VkDiscardRectangleModeEXT -> Int # peekElemOff :: Ptr VkDiscardRectangleModeEXT -> Int -> IO VkDiscardRectangleModeEXT # pokeElemOff :: Ptr VkDiscardRectangleModeEXT -> Int -> VkDiscardRectangleModeEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO VkDiscardRectangleModeEXT # pokeByteOff :: Ptr b -> Int -> VkDiscardRectangleModeEXT -> IO () # peek :: Ptr VkDiscardRectangleModeEXT -> IO VkDiscardRectangleModeEXT # poke :: Ptr VkDiscardRectangleModeEXT -> VkDiscardRectangleModeEXT -> IO () #

Eq VkPhysicalDeviceDiscardRectanglePropertiesEXT Source #
Instance details Methods (==) :: VkPhysicalDeviceDiscardRectanglePropertiesEXT -> VkPhysicalDeviceDiscardRectanglePropertiesEXT -> Bool # (/=) :: VkPhysicalDeviceDiscardRectanglePropertiesEXT -> VkPhysicalDeviceDiscardRectanglePropertiesEXT -> Bool #
Show VkPhysicalDeviceDiscardRectanglePropertiesEXT Source #
Instance details Methods showsPrec :: Int -> VkPhysicalDeviceDiscardRectanglePropertiesEXT -> ShowS # show :: VkPhysicalDeviceDiscardRectanglePropertiesEXT -> String # showList :: [VkPhysicalDeviceDiscardRectanglePropertiesEXT] -> ShowS #
Storable VkPhysicalDeviceDiscardRectanglePropertiesEXT Source #
Instance details Methods sizeOf :: VkPhysicalDeviceDiscardRectanglePropertiesEXT -> Int # alignment :: VkPhysicalDeviceDiscardRectanglePropertiesEXT -> Int # peekElemOff :: Ptr VkPhysicalDeviceDiscardRectanglePropertiesEXT -> Int -> IO VkPhysicalDeviceDiscardRectanglePropertiesEXT # pokeElemOff :: Ptr VkPhysicalDeviceDiscardRectanglePropertiesEXT -> Int -> VkPhysicalDeviceDiscardRectanglePropertiesEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO VkPhysicalDeviceDiscardRectanglePropertiesEXT # pokeByteOff :: Ptr b -> Int -> VkPhysicalDeviceDiscardRectanglePropertiesEXT -> IO () # peek :: Ptr VkPhysicalDeviceDiscardRectanglePropertiesEXT -> IO VkPhysicalDeviceDiscardRectanglePropertiesEXT # poke :: Ptr VkPhysicalDeviceDiscardRectanglePropertiesEXT -> VkPhysicalDeviceDiscardRectanglePropertiesEXT -> IO () #

Eq VkPipelineDiscardRectangleStateCreateInfoEXT Source #
Instance details Methods (==) :: VkPipelineDiscardRectangleStateCreateInfoEXT -> VkPipelineDiscardRectangleStateCreateInfoEXT -> Bool # (/=) :: VkPipelineDiscardRectangleStateCreateInfoEXT -> VkPipelineDiscardRectangleStateCreateInfoEXT -> Bool #
Show VkPipelineDiscardRectangleStateCreateInfoEXT Source #
Instance details Methods showsPrec :: Int -> VkPipelineDiscardRectangleStateCreateInfoEXT -> ShowS # show :: VkPipelineDiscardRectangleStateCreateInfoEXT -> String # showList :: [VkPipelineDiscardRectangleStateCreateInfoEXT] -> ShowS #
Storable VkPipelineDiscardRectangleStateCreateInfoEXT Source #
Instance details Methods sizeOf :: VkPipelineDiscardRectangleStateCreateInfoEXT -> Int # alignment :: VkPipelineDiscardRectangleStateCreateInfoEXT -> Int # peekElemOff :: Ptr VkPipelineDiscardRectangleStateCreateInfoEXT -> Int -> IO VkPipelineDiscardRectangleStateCreateInfoEXT # pokeElemOff :: Ptr VkPipelineDiscardRectangleStateCreateInfoEXT -> Int -> VkPipelineDiscardRectangleStateCreateInfoEXT -> IO () # peekByteOff :: Ptr b -> Int -> IO VkPipelineDiscardRectangleStateCreateInfoEXT # pokeByteOff :: Ptr b -> Int -> VkPipelineDiscardRectangleStateCreateInfoEXT -> IO () # peek :: Ptr VkPipelineDiscardRectangleStateCreateInfoEXT -> IO VkPipelineDiscardRectangleStateCreateInfoEXT # poke :: Ptr VkPipelineDiscardRectangleStateCreateInfoEXT -> VkPipelineDiscardRectangleStateCreateInfoEXT -> IO () #

Documentation

See Also

Description

See Also

Parameters

Description

Valid Usage

Valid Usage (Implicit)

Host Synchronization

Command Properties

See Also

Members

Description

Valid Usage (Implicit)

See Also

Valid Usage

Valid Usage (Implicit)

See Also

VkPhysicalDeviceDiscardRectanglePropertiesEXT
Fields vkSType :: VkStructureType vkPNext :: Ptr () vkMaxDiscardRectangles :: Word32