Release notes

Migration guide #

Migrating to 1.60

Changes in shaders #

The pixel shader additional flags in CohCommonPS.ihlsl should be updated with the following values:

static const int PSAF_LinearColorSpace = 0x1;
static const int PSAF_LinearTextureSpace_0 = 0x2;
static const int PSAF_LinearTextureSpace_1 = 0x4;
static const int PSAF_ColorTextAtlas = 0x8;

The flags PSAF_LinearTextureSpace_0 and PSAF_LinearTextureSpace_1 indicate whether the shader should convert from SRGB to linear color space manually for texture slot txBuffer and txBuffer1 respectively. The conversion should be applied after sampling from textures that contain color values and not arbitrary data (e.g. signed distance field). Example:

float4 source = SAMPLE2D(txBuffer, input.Additional.xy);
if (IS_SET(int(perCommandData.y), PSAF_LinearTextureSpace_0))
{
    source.rgb = SRGBToLinear(source.rgb);
}
...
float4 source1 = SAMPLE2D(txBuffer1, input.Additional.xy);
if (IS_SET(int(perCommandData.y), PSAF_LinearTextureSpace_1))
{
    source1.rgb = SRGBToLinear(source1.rgb);
}

New shader types #

In an effort to reduce stencil usage by improving clipping commands, we introduced 4 new shader types: ST_RoundedRectTexture, ST_CircleTexture, ST_EllipseTexture, ST_RoundedRectTextureRepeat. Their corresponding pixel shader types: PST_RoundedRectTexture, PST_CircleTexture(same as PST_RoundedRectTexture), PST_EllipseTexture, PST_RoundedRectTextureRepeat have been implemented in the CohShadeGeometryRare.ihlsl file. They are almost identical to their respective non-texture shader types, however instead of using the input color, they sample from an image.

In order to send additional data with every vertex, we utilized the StandardVS’s input.Position.z and output.ScreenNormalPosition.z fields, and as a result the CohStandardVS.hlsl shader was altered to null the Z output.Position for the new shader types. Below is the meaning of this field for each new shader type:

The ellipse’s Y-radius in the PST_EllipseTexture shader type is stored inside the perCommandData.x field

Image repetition adjustments #

Along with these changes, the logic behind the way Gameface does image repetition has also been slightly modified. Before, Gameface used to generate a lot of geometry when repeating a subimage from a texture. This has been replaced by a mathematical approach that allows us to correctly calculate the UVs that we need to sample from the texture. In order to do this, the pixel shader type PST_DrawImageRepeat had to be added and implemented inside the CohClipMasking.ihlsl, CohShadeGeometry.ihlsl and CohShadeGeometryStencil.ihlsl files.

Changelog #

Version 1.60.0 #