LWJGL 3.3.3 · org.lwjgl.vulkan.NVCoverageReductionMode

When using a framebuffer with mixed samples, a per-fragment coverage reduction operation is performed which generates color sample coverage from the pixel coverage. This extension defines the following modes to control how this reduction is performed.

Merge: When there are more samples in the pixel coverage than color samples, there is an implementation-dependent association of each pixel coverage sample to a color sample. In the merge mode, the color sample coverage is computed such that only if any associated sample in the pixel coverage is covered, the color sample is covered. This is the default mode.
Truncate: When there are more raster samples (N) than color samples(M), there is one to one association of the first M raster samples to the M color samples; other raster samples are ignored.

When the number of raster samples is equal to the color samples, there is a one to one mapping between them in either of the above modes.

The new command GetPhysicalDeviceSupportedFramebufferMixedSamplesCombinationsNV can be used to query the various raster, color, depth/stencil sample count and reduction mode combinations that are supported by the implementation. This extension would allow an implementation to support the behavior of both VK_NV_framebuffer_mixed_samples and VK_AMD_mixed_attachment_samples extensions simultaneously.

VK_NV_coverage_reduction_mode

Name String

VK_NV_coverage_reduction_mode

Extension Type

Device extension

Registered Extension Number

251

Revision

Extension and Version Dependencies

VK_NV_framebuffer_mixed_samples and VK_KHR_get_physical_device_properties2

Contact

Kedarnath Thangudu kthangudu

Other Extension Metadata

Last Modified Date

2019-01-29

Contributors

Kedarnath Thangudu, NVIDIA
Jeff Bolz, NVIDIA

Field Summary

Modifier and Type	Field and Description
public static final int	VK_COVERAGE_REDUCTION_MODE_MERGE_NV VkCoverageReductionModeNV - Specify the coverage reduction mode Description `COVERAGE_REDUCTION_MODE_MERGE_NV` specifies that each color sample will be associated with an implementation-dependent subset of samples in the pixel coverage. If any of those associated samples are covered, the color sample is covered. `COVERAGE_REDUCTION_MODE_TRUNCATE_NV` specifies that for color samples present in the color attachments, a color sample is covered if the pixel coverage sample with the same sample index `i` is covered; other pixel coverage samples are discarded.
public static final int	VK_COVERAGE_REDUCTION_MODE_TRUNCATE_NV VkCoverageReductionModeNV - Specify the coverage reduction mode Description `COVERAGE_REDUCTION_MODE_MERGE_NV` specifies that each color sample will be associated with an implementation-dependent subset of samples in the pixel coverage. If any of those associated samples are covered, the color sample is covered. `COVERAGE_REDUCTION_MODE_TRUNCATE_NV` specifies that for color samples present in the color attachments, a color sample is covered if the pixel coverage sample with the same sample index `i` is covered; other pixel coverage samples are discarded.
public static final String	VK_NV_COVERAGE_REDUCTION_MODE_EXTENSION_NAME The extension name.
public static final int	VK_NV_COVERAGE_REDUCTION_MODE_SPEC_VERSION The extension specification version.
public static final int	VK_STRUCTURE_TYPE_FRAMEBUFFER_MIXED_SAMPLES_COMBINATION_NV Extends `VkStructureType`.
public static final int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_COVERAGE_REDUCTION_MODE_FEATURES_NV Extends `VkStructureType`.
public static final int	VK_STRUCTURE_TYPE_PIPELINE_COVERAGE_REDUCTION_STATE_CREATE_INFO_NV Extends `VkStructureType`.

Access	Constructor and Description
protected	NVCoverageReductionMode()

Method Summary

Modifier and Type	Method and Description
public static int	nvkGetPhysicalDeviceSupportedFramebufferMixedSamplesCombinationsNV(VkPhysicalDevice physicalDevice, long a pointer to an integer related to the number of combinations available or queried, as described below. pCombinationCount, long pCombinations) Unsafe version of: `GetPhysicalDeviceSupportedFramebufferMixedSamplesCombinationsNV`
public static int	vkGetPhysicalDeviceSupportedFramebufferMixedSamplesCombinationsNV(VkPhysicalDevice the physical device from which to query the set of combinations. physicalDevice, IntBuffer a pointer to an integer related to the number of combinations available or queried, as described below. pCombinationCount, VkFramebufferMixedSamplesCombinationNV.Buffer either `NULL` or a pointer to an array of `VkFramebufferMixedSamplesCombinationNV` values, indicating the supported combinations of coverage reduction mode, rasterization samples, and color, depth, stencil attachment sample counts. pCombinations) Query supported sample count combinations.
public static int	vkGetPhysicalDeviceSupportedFramebufferMixedSamplesCombinationsNV(VkPhysicalDevice physicalDevice, int[] pCombinationCount, VkFramebufferMixedSamplesCombinationNV.Buffer pCombinations) Array version of: `GetPhysicalDeviceSupportedFramebufferMixedSamplesCombinationsNV`

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

VK_COVERAGE_REDUCTION_MODE_MERGE_NV back to summary

VK_COVERAGE_REDUCTION_MODE_MERGE_NV	back to summary
public static final int VK_COVERAGE_REDUCTION_MODE_MERGE_NV VkCoverageReductionModeNV - Specify the coverage reduction mode Description `COVERAGE_REDUCTION_MODE_MERGE_NV` specifies that each color sample will be associated with an implementation-dependent subset of samples in the pixel coverage. If any of those associated samples are covered, the color sample is covered. `COVERAGE_REDUCTION_MODE_TRUNCATE_NV` specifies that for color samples present in the color attachments, a color sample is covered if the pixel coverage sample with the same sample index `i` is covered; other pixel coverage samples are discarded. See Also `VkFramebufferMixedSamplesCombinationNV`, `VkPipelineCoverageReductionStateCreateInfoNV`, `CmdSetCoverageReductionModeNV`

public static final int VK_COVERAGE_REDUCTION_MODE_MERGE_NV

VkCoverageReductionModeNV - Specify the coverage reduction mode

Description

COVERAGE_REDUCTION_MODE_MERGE_NV specifies that each color sample will be associated with an implementation-dependent subset of samples in the pixel coverage. If any of those associated samples are covered, the color sample is covered.
COVERAGE_REDUCTION_MODE_TRUNCATE_NV specifies that for color samples present in the color attachments, a color sample is covered if the pixel coverage sample with the same sample index i is covered; other pixel coverage samples are discarded.

VK_COVERAGE_REDUCTION_MODE_TRUNCATE_NV	back to summary
public static final int VK_COVERAGE_REDUCTION_MODE_TRUNCATE_NV VkCoverageReductionModeNV - Specify the coverage reduction mode Description `COVERAGE_REDUCTION_MODE_MERGE_NV` specifies that each color sample will be associated with an implementation-dependent subset of samples in the pixel coverage. If any of those associated samples are covered, the color sample is covered. `COVERAGE_REDUCTION_MODE_TRUNCATE_NV` specifies that for color samples present in the color attachments, a color sample is covered if the pixel coverage sample with the same sample index `i` is covered; other pixel coverage samples are discarded. See Also `VkFramebufferMixedSamplesCombinationNV`, `VkPipelineCoverageReductionStateCreateInfoNV`, `CmdSetCoverageReductionModeNV`

Description

COVERAGE_REDUCTION_MODE_MERGE_NV specifies that each color sample will be associated with an implementation-dependent subset of samples in the pixel coverage. If any of those associated samples are covered, the color sample is covered.
COVERAGE_REDUCTION_MODE_TRUNCATE_NV specifies that for color samples present in the color attachments, a color sample is covered if the pixel coverage sample with the same sample index i is covered; other pixel coverage samples are discarded.

VK_NV_COVERAGE_REDUCTION_MODE_EXTENSION_NAME	back to summary
public static final String VK_NV_COVERAGE_REDUCTION_MODE_EXTENSION_NAME The extension name.

VK_NV_COVERAGE_REDUCTION_MODE_SPEC_VERSION	back to summary
public static final int VK_NV_COVERAGE_REDUCTION_MODE_SPEC_VERSION The extension specification version.

VK_STRUCTURE_TYPE_FRAMEBUFFER_MIXED_SAMPLES_COMBINATION_NV	back to summary
public static final int VK_STRUCTURE_TYPE_FRAMEBUFFER_MIXED_SAMPLES_COMBINATION_NV Extends `VkStructureType`. Enum values: `STRUCTURE_TYPE_PHYSICAL_DEVICE_COVERAGE_REDUCTION_MODE_FEATURES_NV` `STRUCTURE_TYPE_PIPELINE_COVERAGE_REDUCTION_STATE_CREATE_INFO_NV` `STRUCTURE_TYPE_FRAMEBUFFER_MIXED_SAMPLES_COMBINATION_NV`

Enum values:

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_COVERAGE_REDUCTION_MODE_FEATURES_NV back to summary

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_COVERAGE_REDUCTION_MODE_FEATURES_NV	back to summary
public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_COVERAGE_REDUCTION_MODE_FEATURES_NV Extends `VkStructureType`. Enum values: `STRUCTURE_TYPE_PHYSICAL_DEVICE_COVERAGE_REDUCTION_MODE_FEATURES_NV` `STRUCTURE_TYPE_PIPELINE_COVERAGE_REDUCTION_STATE_CREATE_INFO_NV` `STRUCTURE_TYPE_FRAMEBUFFER_MIXED_SAMPLES_COMBINATION_NV`

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_COVERAGE_REDUCTION_MODE_FEATURES_NV

Extends VkStructureType.

Enum values:

VK_STRUCTURE_TYPE_PIPELINE_COVERAGE_REDUCTION_STATE_CREATE_INFO_NV back to summary

VK_STRUCTURE_TYPE_PIPELINE_COVERAGE_REDUCTION_STATE_CREATE_INFO_NV	back to summary
public static final int VK_STRUCTURE_TYPE_PIPELINE_COVERAGE_REDUCTION_STATE_CREATE_INFO_NV Extends `VkStructureType`. Enum values: `STRUCTURE_TYPE_PHYSICAL_DEVICE_COVERAGE_REDUCTION_MODE_FEATURES_NV` `STRUCTURE_TYPE_PIPELINE_COVERAGE_REDUCTION_STATE_CREATE_INFO_NV` `STRUCTURE_TYPE_FRAMEBUFFER_MIXED_SAMPLES_COMBINATION_NV`

public static final int VK_STRUCTURE_TYPE_PIPELINE_COVERAGE_REDUCTION_STATE_CREATE_INFO_NV

Extends VkStructureType.

Enum values:

Constructor Detail

NVCoverageReductionMode	back to summary
protected NVCoverageReductionMode()

Method Detail

nvkGetPhysicalDeviceSupportedFramebufferMixedSamplesCombinationsNV back to summary

nvkGetPhysicalDeviceSupportedFramebufferMixedSamplesCombinationsNV	back to summary
public static int nvkGetPhysicalDeviceSupportedFramebufferMixedSamplesCombinationsNV(VkPhysicalDevice physicalDevice, long pCombinationCount, long pCombinations) Unsafe version of: `GetPhysicalDeviceSupportedFramebufferMixedSamplesCombinationsNV` Parameters pCombinationCount:long a pointer to an integer related to the number of combinations available or queried, as described below.

public static int nvkGetPhysicalDeviceSupportedFramebufferMixedSamplesCombinationsNV(VkPhysicalDevice physicalDevice, long pCombinationCount, long pCombinations)

Unsafe version of: GetPhysicalDeviceSupportedFramebufferMixedSamplesCombinationsNV

Parameters

pCombinationCount:long: a pointer to an integer related to the number of combinations available or queried, as described below.

vkGetPhysicalDeviceSupportedFramebufferMixedSamplesCombinationsNV back to summary

vkGetPhysicalDeviceSupportedFramebufferMixedSamplesCombinationsNV	back to summary
public static int vkGetPhysicalDeviceSupportedFramebufferMixedSamplesCombinationsNV(VkPhysicalDevice physicalDevice, IntBuffer pCombinationCount, VkFramebufferMixedSamplesCombinationNV.Buffer pCombinations) Query supported sample count combinations. C Specification To query the set of mixed sample combinations of coverage reduction mode, rasterization samples and color, depth, stencil attachment sample counts that are supported by a physical device, call: `VkResult vkGetPhysicalDeviceSupportedFramebufferMixedSamplesCombinationsNV( VkPhysicalDevice physicalDevice, uint32_t* pCombinationCount, VkFramebufferMixedSamplesCombinationNV* pCombinations);` Description If `pCombinations` is `NULL`, then the number of supported combinations for the given `physicalDevice` is returned in `pCombinationCount`. Otherwise, `pCombinationCount` must point to a variable set by the user to the number of elements in the `pCombinations` array, and on return the variable is overwritten with the number of values actually written to `pCombinations`. If the value of `pCombinationCount` is less than the number of combinations supported for the given `physicalDevice`, at most `pCombinationCount` values will be written to `pCombinations`, and `INCOMPLETE` will be returned instead of `SUCCESS`, to indicate that not all the supported values were returned. Valid Usage (Implicit) `physicalDevice` must be a valid `VkPhysicalDevice` handle `pCombinationCount` must be a valid pointer to a `uint32_t` value If the value referenced by `pCombinationCount` is not 0, and `pCombinations` is not `NULL`, `pCombinations` must be a valid pointer to an array of `pCombinationCount` `VkFramebufferMixedSamplesCombinationNV` structures Return Codes On success, this command returns `SUCCESS` `INCOMPLETE` On failure, this command returns `ERROR_OUT_OF_HOST_MEMORY` `ERROR_OUT_OF_DEVICE_MEMORY` See Also `VkFramebufferMixedSamplesCombinationNV` Parameters physicalDevice:VkPhysicalDevice the physical device from which to query the set of combinations. pCombinationCount:IntBuffer a pointer to an integer related to the number of combinations available or queried, as described below. pCombinations:VkFramebufferMixedSamplesCombinationNV.Buffer either `NULL` or a pointer to an array of `VkFramebufferMixedSamplesCombinationNV` values, indicating the supported combinations of coverage reduction mode, rasterization samples, and color, depth, stencil attachment sample counts. Annotations @NativeType:VkResult

public static int vkGetPhysicalDeviceSupportedFramebufferMixedSamplesCombinationsNV(VkPhysicalDevice physicalDevice, IntBuffer pCombinationCount, VkFramebufferMixedSamplesCombinationNV.Buffer pCombinations)

Query supported sample count combinations.

C Specification

To query the set of mixed sample combinations of coverage reduction mode, rasterization samples and color, depth, stencil attachment sample counts that are supported by a physical device, call:


VkResult vkGetPhysicalDeviceSupportedFramebufferMixedSamplesCombinationsNV(
    VkPhysicalDevice                            physicalDevice,
    uint32_t*                                   pCombinationCount,
    VkFramebufferMixedSamplesCombinationNV*     pCombinations);

Description

If pCombinations is NULL, then the number of supported combinations for the given physicalDevice is returned in pCombinationCount. Otherwise, pCombinationCount must point to a variable set by the user to the number of elements in the pCombinations array, and on return the variable is overwritten with the number of values actually written to pCombinations. If the value of pCombinationCount is less than the number of combinations supported for the given physicalDevice, at most pCombinationCount values will be written to pCombinations, and INCOMPLETE will be returned instead of SUCCESS, to indicate that not all the supported values were returned.

Valid Usage (Implicit)

physicalDevice must be a valid VkPhysicalDevice handle
pCombinationCount must be a valid pointer to a uint32_t value
If the value referenced by pCombinationCount is not 0, and pCombinations is not NULL, pCombinations must be a valid pointer to an array of pCombinationCount VkFramebufferMixedSamplesCombinationNV structures

Return Codes

On success, this command returns

On failure, this command returns

public Class NVCoverageReductionMode

VK_NV_coverage_reduction_mode

Other Extension Metadata

Field Summary

Constructor Summary

Method Summary

Field Detail

Description

See Also

Description

See Also

Enum values:

Enum values:

Enum values:

Constructor Detail

Method Detail

C Specification

Description

Valid Usage (Implicit)

Return Codes

See Also