RSSetShadingRateImage (XBOX Series consoles)

Sets the screen-space shading-rate image for variable-rate shading (VRS). For more info, see Variable-rate shading (VRS). This method requires Tier2 Variable-rate shading (VRS) support. See D3D12_FEATURE_DATA_D3D12_OPTIONS6 and D3D12_VARIABLE_SHADING_RATE_TIER.

Syntax

void RSSetShadingRateImage(
    ID3D12Resource  shadingRateImage
)

Parameters

shadingRateImage
Type: ID3D12Resource * An optional pointer to an ID3D12Resource representing a screen-space shading-rate image. If NULL, the effect is the same as having a shading-rate image where all values are a shading rate of 1x1. This texture must have the D3D12_RESOURCE_STATE_SHADING_RATE_SOURCE state applied. The tile-size of the shading-rate image can be determined via D3D12_FEATURE_DATA_D3D12_OPTIONS6. The size of the shading-rate image should therefore be

ceil((float)rtWidth / VRSTileSize), ceil((float)rtHeight / VRSTileSize)

The shading-rate image must be a 2D texture with a single mip, and format DXGI_FORMAT_R8_UINT. Each texel must be a value corresponding to D3D12_SHADING_RATE. It must have layout D3D12_TEXTURE_LAYOUT_UNKNOWN and can’t be a depth-stencil, render-target, simultaneous-access, or cross-adapter resource. As (0, 0) is the top left in DirectX, a too-small or large shading-rate image results in the bottom or right having no shading-rate image area, or the image extending in these directions. When there is excess, it is ignored (but legal), and when the image is too small, all out-of-bounds areas in the bottom and right will have the default shading rate of 1x1 from the image (however, this does not mean that is the final shading rate. The combiners will still be applied to this 1x1 default value).

Return value

Type: void None.

Remarks

For the screen-space shading-rate image to take affect, ID3D12GraphicsCommandList5::RSSetShadingRate must have been called to set the combiners for shading. Else, with the default combiners (both D3D12_SHADING_RATE_COMBINER_PASSTHROUGH), the screen-space shading-rate image is ignored in determining shading granularity. The second combiner passed to [ID3D12GraphicsCommandList5::RSSetShadingRate] is the one which applies to the shading-rate image, which occurs after the global shading rate and the per-primitive shading rate have been combined. The algorithm for final shading-rate is determined by

postRasterizerRate = ApplyCombiner(Combiners[0], CommandListShadingRate, Primitive->PrimitiveSpecifiedShadingRate);
finalRate = ApplyCombiner(Combiners[1], postRasterizerRate, ScreenSpaceImage[xy]);

where ApplyCombiner is

UINT ApplyCombiner(D3D12_SHADING_RATE_COMBINER combiner, UINT a, UINT b)
{
MaxShadingRate = options6.AdditionalShadingRatesSupported ? 4 : 2;
switch (combiner)
{
case D3D12_SHADING_RATE_COMBINER_PASSTHROUGH: // default
return a;
case D3D12_SHADING_RATE_COMBINER_OVERRIDE:
return b;
case D3D12_SHADING_RATE_COMBINER_MAX:
return max(a, b);
case D3D12_SHADING_RATE_COMBINER_MIN:
return min(a, b);
case D3D12_SHADING_RATE_COMBINER_SUM:
return min(MaxShadingRate, a + b);
case default:
return a;
}
}

Requirements

Header: d3d12_xs.h
Library: d3d12_xs.lib
Supported Platforms: XBOX Series consoles

(all) API references

Error codes

Audio API reference

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

Syntax

Parameters

Return value

Remarks

Requirements

See Also

​Syntax

​Parameters

​Return value

​Remarks

​Requirements

​See Also

Syntax

Parameters

Return value

Remarks

Requirements

See Also