Vulkan.Extensions.VK_NV_shading_rate_image

Documentation

cmdBindShadingRateImageNV :: forall io. MonadIO io => CommandBuffer -> ImageView -> ImageLayout -> io ()

vkCmdBindShadingRateImageNV - Bind a shading rate image on a command buffer

Parameters

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

• imageView is an image view handle specifying the shading rate image. imageView may be set to NULL_HANDLE, which is equivalent to specifying a view of an image filled with zero values.
• imageLayout is the layout that the image subresources accessible from imageView will be in when the shading rate image is accessed.

Valid Usage

• The shading rate image feature must be enabled

• If imageView is not NULL_HANDLE, it must be a valid ImageView handle of type IMAGE_VIEW_TYPE_2D or IMAGE_VIEW_TYPE_2D_ARRAY
• If imageView is not NULL_HANDLE, it must have a format of FORMAT_R8_UINT
• If imageView is not NULL_HANDLE, it must have been created with a usage value including IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV
• If imageView is not NULL_HANDLE, imageLayout must match the actual ImageLayout of each subresource accessible from imageView at the time the subresource is accessed
• If imageView is not NULL_HANDLE, imageLayout must be IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV or IMAGE_LAYOUT_GENERAL

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• If imageView is not NULL_HANDLE, imageView must be a valid ImageView handle
• imageLayout must be a valid ImageLayout value
• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support graphics operations
• Both of commandBuffer, and imageView that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same Device

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, ImageLayout, ImageView

cmdSetViewportShadingRatePaletteNV :: forall io. MonadIO io => CommandBuffer -> ("firstViewport" ::: Word32) -> ("shadingRatePalettes" ::: Vector ShadingRatePaletteNV) -> io ()

vkCmdSetViewportShadingRatePaletteNV - Set shading rate image palettes on a command buffer

Parameters

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

• firstViewport is the index of the first viewport whose shading rate palette is updated by the command.
• viewportCount is the number of viewports whose shading rate palettes are updated by the command.
• pShadingRatePalettes is a pointer to an array of ShadingRatePaletteNV structures defining the palette for each viewport.

Valid Usage

• The shading rate image feature must be enabled

• firstViewport must be less than PhysicalDeviceLimits::maxViewports
• The sum of firstViewport and viewportCount must be between 1 and PhysicalDeviceLimits::maxViewports, inclusive
• If the multiple viewports feature is not enabled, firstViewport must be 0
• If the multiple viewports feature is not enabled, viewportCount must be 1

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

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

cmdSetCoarseSampleOrderNV :: forall io. MonadIO io => CommandBuffer -> CoarseSampleOrderTypeNV -> ("customSampleOrders" ::: Vector CoarseSampleOrderCustomNV) -> io ()

vkCmdSetCoarseSampleOrderNV - Set sample order for coarse fragments on a command buffer

Parameters

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

• sampleOrderType specifies the mechanism used to order coverage samples in fragments larger than one pixel.
• customSampleOrderCount specifies the number of custom sample orderings to use when ordering coverage samples.
• pCustomSampleOrders is a pointer to an array of CoarseSampleOrderCustomNV structures, each of which specifies the coverage sample order for a single combination of fragment area and coverage sample count.

Description

If sampleOrderType is COARSE_SAMPLE_ORDER_TYPE_CUSTOM_NV, the coverage sample order used for any combination of fragment area and coverage sample count not enumerated in pCustomSampleOrders will be identical to that used for COARSE_SAMPLE_ORDER_TYPE_DEFAULT_NV.

Valid Usage

• If sampleOrderType is not COARSE_SAMPLE_ORDER_TYPE_CUSTOM_NV, customSamplerOrderCount must be 0

• The array pCustomSampleOrders must not contain two structures with matching values for both the shadingRate and sampleCount members

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• sampleOrderType must be a valid CoarseSampleOrderTypeNV value
• If customSampleOrderCount is not 0, pCustomSampleOrders must be a valid pointer to an array of customSampleOrderCount valid CoarseSampleOrderCustomNV structures
• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support graphics operations

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

CoarseSampleOrderCustomNV, CoarseSampleOrderTypeNV, CommandBuffer

data ShadingRatePaletteNV

VkShadingRatePaletteNV - Structure specifying a single shading rate palette

Valid Usage (Implicit)

See Also

PipelineViewportShadingRateImageStateCreateInfoNV, ShadingRatePaletteEntryNV, cmdSetViewportShadingRatePaletteNV

Constructors

ShadingRatePaletteNV

Fields

• shadingRatePaletteEntries :: Vector ShadingRatePaletteEntryNV

  pShadingRatePaletteEntries must be a valid pointer to an array of shadingRatePaletteEntryCount valid ShadingRatePaletteEntryNV values

Instances

Show ShadingRatePaletteNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

showsPrec :: Int -> ShadingRatePaletteNV -> ShowS

show :: ShadingRatePaletteNV -> String

showList :: [ShadingRatePaletteNV] -> ShowS

FromCStruct ShadingRatePaletteNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

peekCStruct :: Ptr ShadingRatePaletteNV -> IO ShadingRatePaletteNV

ToCStruct ShadingRatePaletteNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

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

pokeCStruct :: Ptr ShadingRatePaletteNV -> ShadingRatePaletteNV -> IO b -> IO b

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

pokeZeroCStruct :: Ptr ShadingRatePaletteNV -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero ShadingRatePaletteNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

zero :: ShadingRatePaletteNV

data PipelineViewportShadingRateImageStateCreateInfoNV

VkPipelineViewportShadingRateImageStateCreateInfoNV - Structure specifying parameters controlling shading rate image usage

Description

If this structure is not present, shadingRateImageEnable is considered to be FALSE, and the shading rate image and palettes are not used.

Valid Usage

• If the multiple viewports feature is not enabled, viewportCount must be 0 or 1

• viewportCount must be less than or equal to PhysicalDeviceLimits::maxViewports
• If shadingRateImageEnable is TRUE, viewportCount must be equal to the viewportCount member of PipelineViewportStateCreateInfo
• If no element of the pDynamicStates member of pDynamicState is DYNAMIC_STATE_VIEWPORT_SHADING_RATE_PALETTE_NV, pShadingRatePalettes must be a valid pointer to an array of viewportCount ShadingRatePaletteNV structures

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_VIEWPORT_SHADING_RATE_IMAGE_STATE_CREATE_INFO_NV

• If viewportCount is not 0, and pShadingRatePalettes is not NULL, pShadingRatePalettes must be a valid pointer to an array of viewportCount valid ShadingRatePaletteNV structures

See Also

Bool32, ShadingRatePaletteNV, StructureType

Constructors

PipelineViewportShadingRateImageStateCreateInfoNV

Fields

• shadingRateImageEnable :: Bool

  shadingRateImageEnable specifies whether shading rate image and palettes are used during rasterization.

• viewportCount :: Word32

  viewportCount specifies the number of per-viewport palettes used to translate values stored in shading rate images.

• shadingRatePalettes :: Vector ShadingRatePaletteNV

  pShadingRatePalettes is a pointer to an array of ShadingRatePaletteNV structures defining the palette for each viewport. If the shading rate palette state is dynamic, this member is ignored.

Instances

Show PipelineViewportShadingRateImageStateCreateInfoNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

showsPrec :: Int -> PipelineViewportShadingRateImageStateCreateInfoNV -> ShowS

show :: PipelineViewportShadingRateImageStateCreateInfoNV -> String

showList :: [PipelineViewportShadingRateImageStateCreateInfoNV] -> ShowS

FromCStruct PipelineViewportShadingRateImageStateCreateInfoNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

peekCStruct :: Ptr PipelineViewportShadingRateImageStateCreateInfoNV -> IO PipelineViewportShadingRateImageStateCreateInfoNV

ToCStruct PipelineViewportShadingRateImageStateCreateInfoNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

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

pokeCStruct :: Ptr PipelineViewportShadingRateImageStateCreateInfoNV -> PipelineViewportShadingRateImageStateCreateInfoNV -> IO b -> IO b

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

pokeZeroCStruct :: Ptr PipelineViewportShadingRateImageStateCreateInfoNV -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PipelineViewportShadingRateImageStateCreateInfoNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

zero :: PipelineViewportShadingRateImageStateCreateInfoNV

data PhysicalDeviceShadingRateImageFeaturesNV

VkPhysicalDeviceShadingRateImageFeaturesNV - Structure describing shading rate image features that can be supported by an implementation

Members

The members of the PhysicalDeviceShadingRateImageFeaturesNV structure describe the following features:

Description

See Shading Rate Image for more information.

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

Valid Usage (Implicit)

See Also

Bool32, StructureType

Constructors

PhysicalDeviceShadingRateImageFeaturesNV

Fields

• shadingRateImage :: Bool

  shadingRateImage indicates that the implementation supports the use of a shading rate image to derive an effective shading rate for fragment processing. It also indicates that the implementation supports the ShadingRateNV SPIR-V execution mode.

• shadingRateCoarseSampleOrder :: Bool

  shadingRateCoarseSampleOrder indicates that the implementation supports a user-configurable ordering of coverage samples in fragments larger than one pixel.

Instances

Show PhysicalDeviceShadingRateImageFeaturesNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

showsPrec :: Int -> PhysicalDeviceShadingRateImageFeaturesNV -> ShowS

show :: PhysicalDeviceShadingRateImageFeaturesNV -> String

showList :: [PhysicalDeviceShadingRateImageFeaturesNV] -> ShowS

Storable PhysicalDeviceShadingRateImageFeaturesNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

sizeOf :: PhysicalDeviceShadingRateImageFeaturesNV -> Int

alignment :: PhysicalDeviceShadingRateImageFeaturesNV -> Int

peekElemOff :: Ptr PhysicalDeviceShadingRateImageFeaturesNV -> Int -> IO PhysicalDeviceShadingRateImageFeaturesNV

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

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

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

peek :: Ptr PhysicalDeviceShadingRateImageFeaturesNV -> IO PhysicalDeviceShadingRateImageFeaturesNV

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

FromCStruct PhysicalDeviceShadingRateImageFeaturesNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

peekCStruct :: Ptr PhysicalDeviceShadingRateImageFeaturesNV -> IO PhysicalDeviceShadingRateImageFeaturesNV

ToCStruct PhysicalDeviceShadingRateImageFeaturesNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

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

pokeCStruct :: Ptr PhysicalDeviceShadingRateImageFeaturesNV -> PhysicalDeviceShadingRateImageFeaturesNV -> IO b -> IO b

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

pokeZeroCStruct :: Ptr PhysicalDeviceShadingRateImageFeaturesNV -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceShadingRateImageFeaturesNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

zero :: PhysicalDeviceShadingRateImageFeaturesNV

data PhysicalDeviceShadingRateImagePropertiesNV

VkPhysicalDeviceShadingRateImagePropertiesNV - Structure describing shading rate image limits that can be supported by an implementation

Members

The members of the PhysicalDeviceShadingRateImagePropertiesNV structure describe the following implementation-dependent properties related to the shading rate image feature:

Description

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

Valid Usage (Implicit)

See Also

Extent2D, StructureType

Constructors

PhysicalDeviceShadingRateImagePropertiesNV

Fields

• shadingRateTexelSize :: Extent2D

  shadingRateTexelSize indicates the width and height of the portion of the framebuffer corresponding to each texel in the shading rate image.

• shadingRatePaletteSize :: Word32

  shadingRatePaletteSize indicates the maximum number of palette entries supported for the shading rate image.

• shadingRateMaxCoarseSamples :: Word32

  shadingRateMaxCoarseSamples specifies the maximum number of coverage samples supported in a single fragment. If the product of the fragment size derived from the base shading rate and the number of coverage samples per pixel exceeds this limit, the final shading rate will be adjusted so that its product does not exceed the limit.

Instances

Show PhysicalDeviceShadingRateImagePropertiesNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

showsPrec :: Int -> PhysicalDeviceShadingRateImagePropertiesNV -> ShowS

show :: PhysicalDeviceShadingRateImagePropertiesNV -> String

showList :: [PhysicalDeviceShadingRateImagePropertiesNV] -> ShowS

FromCStruct PhysicalDeviceShadingRateImagePropertiesNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

peekCStruct :: Ptr PhysicalDeviceShadingRateImagePropertiesNV -> IO PhysicalDeviceShadingRateImagePropertiesNV

ToCStruct PhysicalDeviceShadingRateImagePropertiesNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

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

pokeCStruct :: Ptr PhysicalDeviceShadingRateImagePropertiesNV -> PhysicalDeviceShadingRateImagePropertiesNV -> IO b -> IO b

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

pokeZeroCStruct :: Ptr PhysicalDeviceShadingRateImagePropertiesNV -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceShadingRateImagePropertiesNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

zero :: PhysicalDeviceShadingRateImagePropertiesNV

data CoarseSampleLocationNV

VkCoarseSampleLocationNV - Structure specifying parameters controlling shading rate image usage

Valid Usage

See Also

CoarseSampleOrderCustomNV

Constructors

CoarseSampleLocationNV

Fields

• pixelX :: Word32

  pixelX must be less than the width (in pixels) of the fragment

• pixelY :: Word32

  pixelY must be less than the height (in pixels) of the fragment

• sample :: Word32

  sample must be less than the number of coverage samples in each pixel belonging to the fragment

Instances

Show CoarseSampleLocationNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

showsPrec :: Int -> CoarseSampleLocationNV -> ShowS

show :: CoarseSampleLocationNV -> String

showList :: [CoarseSampleLocationNV] -> ShowS

Storable CoarseSampleLocationNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

sizeOf :: CoarseSampleLocationNV -> Int

alignment :: CoarseSampleLocationNV -> Int

peekElemOff :: Ptr CoarseSampleLocationNV -> Int -> IO CoarseSampleLocationNV

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

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

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

peek :: Ptr CoarseSampleLocationNV -> IO CoarseSampleLocationNV

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

FromCStruct CoarseSampleLocationNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

peekCStruct :: Ptr CoarseSampleLocationNV -> IO CoarseSampleLocationNV

ToCStruct CoarseSampleLocationNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

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

pokeCStruct :: Ptr CoarseSampleLocationNV -> CoarseSampleLocationNV -> IO b -> IO b

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

pokeZeroCStruct :: Ptr CoarseSampleLocationNV -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero CoarseSampleLocationNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

zero :: CoarseSampleLocationNV

data CoarseSampleOrderCustomNV

VkCoarseSampleOrderCustomNV - Structure specifying parameters controlling shading rate image usage

Description

When using a custom sample ordering, element j in pSampleLocations specifies a specific pixel location and sample index that corresponds to coverage index j in the multi-pixel fragment.

Valid Usage

• shadingRate must be a shading rate that generates fragments with more than one pixel

• sampleCount must correspond to a sample count enumerated in SampleCountFlags whose corresponding bit is set in PhysicalDeviceLimits::framebufferNoAttachmentsSampleCounts
• sampleLocationCount must be equal to the product of sampleCount, the fragment width for shadingRate, and the fragment height for shadingRate
• sampleLocationCount must be less than or equal to the value of PhysicalDeviceShadingRateImagePropertiesNV::shadingRateMaxCoarseSamples
• The array pSampleLocations must contain exactly one entry for every combination of valid values for pixelX, pixelY, and sample in the structure CoarseSampleOrderCustomNV

Valid Usage (Implicit)

• shadingRate must be a valid ShadingRatePaletteEntryNV value

• pSampleLocations must be a valid pointer to an array of sampleLocationCount CoarseSampleLocationNV structures
• sampleLocationCount must be greater than 0

See Also

CoarseSampleLocationNV, PipelineViewportCoarseSampleOrderStateCreateInfoNV, ShadingRatePaletteEntryNV, cmdSetCoarseSampleOrderNV

Constructors

CoarseSampleOrderCustomNV

Fields

• shadingRate :: ShadingRatePaletteEntryNV

  shadingRate is a shading rate palette entry that identifies the fragment width and height for the combination of fragment area and per-pixel coverage sample count to control.

• sampleCount :: Word32

  sampleCount identifies the per-pixel coverage sample count for the combination of fragment area and coverage sample count to control.

• sampleLocations :: Vector CoarseSampleLocationNV

  pSampleLocations is a pointer to an array of CoarseSampleOrderCustomNV structures specifying the location of each sample in the custom ordering.

Instances

Show CoarseSampleOrderCustomNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

showsPrec :: Int -> CoarseSampleOrderCustomNV -> ShowS

show :: CoarseSampleOrderCustomNV -> String

showList :: [CoarseSampleOrderCustomNV] -> ShowS

FromCStruct CoarseSampleOrderCustomNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

peekCStruct :: Ptr CoarseSampleOrderCustomNV -> IO CoarseSampleOrderCustomNV

ToCStruct CoarseSampleOrderCustomNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

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

pokeCStruct :: Ptr CoarseSampleOrderCustomNV -> CoarseSampleOrderCustomNV -> IO b -> IO b

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

pokeZeroCStruct :: Ptr CoarseSampleOrderCustomNV -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero CoarseSampleOrderCustomNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

zero :: CoarseSampleOrderCustomNV

data PipelineViewportCoarseSampleOrderStateCreateInfoNV

VkPipelineViewportCoarseSampleOrderStateCreateInfoNV - Structure specifying parameters controlling sample order in coarse fragments

Description

If this structure is not present, sampleOrderType is considered to be COARSE_SAMPLE_ORDER_TYPE_DEFAULT_NV.

If sampleOrderType is COARSE_SAMPLE_ORDER_TYPE_CUSTOM_NV, the coverage sample order used for any combination of fragment area and coverage sample count not enumerated in pCustomSampleOrders will be identical to that used for COARSE_SAMPLE_ORDER_TYPE_DEFAULT_NV.

If the pipeline was created with DYNAMIC_STATE_VIEWPORT_COARSE_SAMPLE_ORDER_NV, the contents of this structure (if present) are ignored, and the coverage sample order is instead specified by cmdSetCoarseSampleOrderNV.

Valid Usage

• If sampleOrderType is not COARSE_SAMPLE_ORDER_TYPE_CUSTOM_NV, customSamplerOrderCount must be 0

• The array pCustomSampleOrders must not contain two structures with matching values for both the shadingRate and sampleCount members

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_VIEWPORT_COARSE_SAMPLE_ORDER_STATE_CREATE_INFO_NV

• sampleOrderType must be a valid CoarseSampleOrderTypeNV value
• If customSampleOrderCount is not 0, pCustomSampleOrders must be a valid pointer to an array of customSampleOrderCount valid CoarseSampleOrderCustomNV structures

See Also

CoarseSampleOrderCustomNV, CoarseSampleOrderTypeNV, StructureType

Constructors

PipelineViewportCoarseSampleOrderStateCreateInfoNV

Fields

• sampleOrderType :: CoarseSampleOrderTypeNV

  sampleOrderType specifies the mechanism used to order coverage samples in fragments larger than one pixel.

• customSampleOrders :: Vector CoarseSampleOrderCustomNV

  pCustomSampleOrders is a pointer to an array of customSampleOrderCount CoarseSampleOrderCustomNV structures, each of which specifies the coverage sample order for a single combination of fragment area and coverage sample count.

Instances

Show PipelineViewportCoarseSampleOrderStateCreateInfoNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

showsPrec :: Int -> PipelineViewportCoarseSampleOrderStateCreateInfoNV -> ShowS

show :: PipelineViewportCoarseSampleOrderStateCreateInfoNV -> String

showList :: [PipelineViewportCoarseSampleOrderStateCreateInfoNV] -> ShowS

FromCStruct PipelineViewportCoarseSampleOrderStateCreateInfoNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

peekCStruct :: Ptr PipelineViewportCoarseSampleOrderStateCreateInfoNV -> IO PipelineViewportCoarseSampleOrderStateCreateInfoNV

ToCStruct PipelineViewportCoarseSampleOrderStateCreateInfoNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

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

pokeCStruct :: Ptr PipelineViewportCoarseSampleOrderStateCreateInfoNV -> PipelineViewportCoarseSampleOrderStateCreateInfoNV -> IO b -> IO b

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

pokeZeroCStruct :: Ptr PipelineViewportCoarseSampleOrderStateCreateInfoNV -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PipelineViewportCoarseSampleOrderStateCreateInfoNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

zero :: PipelineViewportCoarseSampleOrderStateCreateInfoNV

newtype ShadingRatePaletteEntryNV

VkShadingRatePaletteEntryNV - Shading rate image palette entry types

Description

The following table indicates the width and height (in pixels) of each fragment generated using the indicated shading rate, as well as the maximum number of fragment shader invocations launched for each fragment. When processing regions of a primitive that have a shading rate of SHADING_RATE_PALETTE_ENTRY_NO_INVOCATIONS_NV, no fragments will be generated in that region.

Shading Rate	Width	Height	Invocations
SHADING_RATE_PALETTE_ENTRY_NO_INVOCATIONS_NV	0	0	0
SHADING_RATE_PALETTE_ENTRY_16_INVOCATIONS_PER_PIXEL_NV	1	1	16
SHADING_RATE_PALETTE_ENTRY_8_INVOCATIONS_PER_PIXEL_NV	1	1	8
SHADING_RATE_PALETTE_ENTRY_4_INVOCATIONS_PER_PIXEL_NV	1	1	4
SHADING_RATE_PALETTE_ENTRY_2_INVOCATIONS_PER_PIXEL_NV	1	1	2
SHADING_RATE_PALETTE_ENTRY_1_INVOCATION_PER_PIXEL_NV	1	1	1
SHADING_RATE_PALETTE_ENTRY_1_INVOCATION_PER_2X1_PIXELS_NV	2	1	1
SHADING_RATE_PALETTE_ENTRY_1_INVOCATION_PER_1X2_PIXELS_NV	1	2	1
SHADING_RATE_PALETTE_ENTRY_1_INVOCATION_PER_2X2_PIXELS_NV	2	2	1
SHADING_RATE_PALETTE_ENTRY_1_INVOCATION_PER_4X2_PIXELS_NV	4	2	1
SHADING_RATE_PALETTE_ENTRY_1_INVOCATION_PER_2X4_PIXELS_NV	2	4	1
SHADING_RATE_PALETTE_ENTRY_1_INVOCATION_PER_4X4_PIXELS_NV	4	4	1

See Also

CoarseSampleOrderCustomNV, ShadingRatePaletteNV

Constructors

ShadingRatePaletteEntryNV Int32

Bundled Patterns

pattern SHADING_RATE_PALETTE_ENTRY_NO_INVOCATIONS_NV :: ShadingRatePaletteEntryNV

pattern SHADING_RATE_PALETTE_ENTRY_16_INVOCATIONS_PER_PIXEL_NV :: ShadingRatePaletteEntryNV

pattern SHADING_RATE_PALETTE_ENTRY_8_INVOCATIONS_PER_PIXEL_NV :: ShadingRatePaletteEntryNV

pattern SHADING_RATE_PALETTE_ENTRY_4_INVOCATIONS_PER_PIXEL_NV :: ShadingRatePaletteEntryNV

pattern SHADING_RATE_PALETTE_ENTRY_2_INVOCATIONS_PER_PIXEL_NV :: ShadingRatePaletteEntryNV

pattern SHADING_RATE_PALETTE_ENTRY_1_INVOCATION_PER_PIXEL_NV :: ShadingRatePaletteEntryNV

pattern SHADING_RATE_PALETTE_ENTRY_1_INVOCATION_PER_2X1_PIXELS_NV :: ShadingRatePaletteEntryNV

pattern SHADING_RATE_PALETTE_ENTRY_1_INVOCATION_PER_1X2_PIXELS_NV :: ShadingRatePaletteEntryNV

pattern SHADING_RATE_PALETTE_ENTRY_1_INVOCATION_PER_2X2_PIXELS_NV :: ShadingRatePaletteEntryNV

pattern SHADING_RATE_PALETTE_ENTRY_1_INVOCATION_PER_4X2_PIXELS_NV :: ShadingRatePaletteEntryNV

pattern SHADING_RATE_PALETTE_ENTRY_1_INVOCATION_PER_2X4_PIXELS_NV :: ShadingRatePaletteEntryNV

pattern SHADING_RATE_PALETTE_ENTRY_1_INVOCATION_PER_4X4_PIXELS_NV :: ShadingRatePaletteEntryNV

Instances

Eq ShadingRatePaletteEntryNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

(==) :: ShadingRatePaletteEntryNV -> ShadingRatePaletteEntryNV -> Bool

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

Ord ShadingRatePaletteEntryNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

compare :: ShadingRatePaletteEntryNV -> ShadingRatePaletteEntryNV -> Ordering

(<) :: ShadingRatePaletteEntryNV -> ShadingRatePaletteEntryNV -> Bool

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

(>) :: ShadingRatePaletteEntryNV -> ShadingRatePaletteEntryNV -> Bool

(>=) :: ShadingRatePaletteEntryNV -> ShadingRatePaletteEntryNV -> Bool

max :: ShadingRatePaletteEntryNV -> ShadingRatePaletteEntryNV -> ShadingRatePaletteEntryNV

min :: ShadingRatePaletteEntryNV -> ShadingRatePaletteEntryNV -> ShadingRatePaletteEntryNV

Read ShadingRatePaletteEntryNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

readsPrec :: Int -> ReadS ShadingRatePaletteEntryNV

readList :: ReadS [ShadingRatePaletteEntryNV]

readPrec :: ReadPrec ShadingRatePaletteEntryNV

readListPrec :: ReadPrec [ShadingRatePaletteEntryNV]

Show ShadingRatePaletteEntryNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

showsPrec :: Int -> ShadingRatePaletteEntryNV -> ShowS

show :: ShadingRatePaletteEntryNV -> String

showList :: [ShadingRatePaletteEntryNV] -> ShowS

Storable ShadingRatePaletteEntryNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

sizeOf :: ShadingRatePaletteEntryNV -> Int

alignment :: ShadingRatePaletteEntryNV -> Int

peekElemOff :: Ptr ShadingRatePaletteEntryNV -> Int -> IO ShadingRatePaletteEntryNV

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

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

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

peek :: Ptr ShadingRatePaletteEntryNV -> IO ShadingRatePaletteEntryNV

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

Zero ShadingRatePaletteEntryNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

zero :: ShadingRatePaletteEntryNV

newtype CoarseSampleOrderTypeNV

VkCoarseSampleOrderTypeNV - Shading rate image sample ordering types

See Also

PipelineViewportCoarseSampleOrderStateCreateInfoNV, cmdSetCoarseSampleOrderNV

Constructors

CoarseSampleOrderTypeNV Int32

Bundled Patterns

pattern COARSE_SAMPLE_ORDER_TYPE_DEFAULT_NV :: CoarseSampleOrderTypeNV

COARSE_SAMPLE_ORDER_TYPE_DEFAULT_NV specifies that coverage samples will be ordered in an implementation-dependent manner.

pattern COARSE_SAMPLE_ORDER_TYPE_CUSTOM_NV :: CoarseSampleOrderTypeNV

COARSE_SAMPLE_ORDER_TYPE_CUSTOM_NV specifies that coverage samples will be ordered according to the array of custom orderings provided in either the pCustomSampleOrders member of PipelineViewportCoarseSampleOrderStateCreateInfoNV or the pCustomSampleOrders member of cmdSetCoarseSampleOrderNV.

pattern COARSE_SAMPLE_ORDER_TYPE_PIXEL_MAJOR_NV :: CoarseSampleOrderTypeNV

COARSE_SAMPLE_ORDER_TYPE_PIXEL_MAJOR_NV specifies that coverage samples will be ordered sequentially, sorted first by pixel coordinate (in row-major order) and then by sample index.

pattern COARSE_SAMPLE_ORDER_TYPE_SAMPLE_MAJOR_NV :: CoarseSampleOrderTypeNV

COARSE_SAMPLE_ORDER_TYPE_SAMPLE_MAJOR_NV specifies that coverage samples will be ordered sequentially, sorted first by sample index and then by pixel coordinate (in row-major order).

Instances

Eq CoarseSampleOrderTypeNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

(==) :: CoarseSampleOrderTypeNV -> CoarseSampleOrderTypeNV -> Bool

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

Ord CoarseSampleOrderTypeNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

compare :: CoarseSampleOrderTypeNV -> CoarseSampleOrderTypeNV -> Ordering

(<) :: CoarseSampleOrderTypeNV -> CoarseSampleOrderTypeNV -> Bool

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

(>) :: CoarseSampleOrderTypeNV -> CoarseSampleOrderTypeNV -> Bool

(>=) :: CoarseSampleOrderTypeNV -> CoarseSampleOrderTypeNV -> Bool

max :: CoarseSampleOrderTypeNV -> CoarseSampleOrderTypeNV -> CoarseSampleOrderTypeNV

min :: CoarseSampleOrderTypeNV -> CoarseSampleOrderTypeNV -> CoarseSampleOrderTypeNV

Read CoarseSampleOrderTypeNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

readsPrec :: Int -> ReadS CoarseSampleOrderTypeNV

readList :: ReadS [CoarseSampleOrderTypeNV]

readPrec :: ReadPrec CoarseSampleOrderTypeNV

readListPrec :: ReadPrec [CoarseSampleOrderTypeNV]

Show CoarseSampleOrderTypeNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

showsPrec :: Int -> CoarseSampleOrderTypeNV -> ShowS

show :: CoarseSampleOrderTypeNV -> String

showList :: [CoarseSampleOrderTypeNV] -> ShowS

Storable CoarseSampleOrderTypeNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

sizeOf :: CoarseSampleOrderTypeNV -> Int

alignment :: CoarseSampleOrderTypeNV -> Int

peekElemOff :: Ptr CoarseSampleOrderTypeNV -> Int -> IO CoarseSampleOrderTypeNV

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

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

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

peek :: Ptr CoarseSampleOrderTypeNV -> IO CoarseSampleOrderTypeNV

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

Zero CoarseSampleOrderTypeNV

Defined in Vulkan.Extensions.VK_NV_shading_rate_image

Methods

zero :: CoarseSampleOrderTypeNV

type NV_SHADING_RATE_IMAGE_SPEC_VERSION = 3

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

type NV_SHADING_RATE_IMAGE_EXTENSION_NAME = "VK_NV_shading_rate_image"

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