Release notes

Changelog #

Version 1.38.0 #

Migration guide #

Changed Stroke Circle / Stroke Rounded Rectangle shader #

After changing the input.Additional.z for the Stroke Rounded Rectangle and Stroke Circle geometry to be the sum of the radius and half of the stroke width, the shader also had to be altered. Meaning that in this version of Gameface, the Stroke Rounded Rectangle and Stroke Circle shader (when ShaderType is 2) has been changed. Before, to calculate distance2OuterEdge we used to subtract the sum of the radius (input.Additional.z) and half of the stroke width (input.Additional.w) from de(distance between the current pixel and the center of the circle). Now we only subtract the radius. Moreover, to calculate distance2InnerEdge, we now subtract the difference between the radius and half of the stroke width instead of the whole stroke width from de.

Before:

> CohShadeGeometryRare.ihlsl
…
const float de = length(posPixels - input.Additional.xy);
const float distance2OuterEdge = de - (input.Additional.z + input.Additional.w / 2);
const float distance2InnerEdge = de - (input.Additional.z - input.Additional.w / 2);
…

After:

> CohShadeGeometryRare.ihlsl
…
const float de = length(posPixels - input.Additional.xy);
const float distance2OuterEdge = de - input.Additional.z;
const float distance2InnerEdge = de - (input.Additional.z - input.Additional.w);
…

Added new texture property #

Previously

The description (Texture2D object) has a field named Props. It’s used to set some flags for the texture which can provide some specific information. We’ve added new flag called ImageProperties::IMP_ClearOnInit by which we should understand that the texture should be cleared when it’s being created. Previously, we were sending empty data to the backend, so the flag was added to save up some memory.

Some rendering APIs can directly memset the texture memory while others should allocate some temporary memory and update the texture’s resource with it. Below you can check an example of the simplest approach to migrate this change:

dxVector<unsigned char> empty;
// Renoir expects text atlases to be clear before usage.
// Previsouly we were sending empty data from Renoir, but this can result in memory spikes
// if many atlases need to be allocated in single frame and it was meaningless to send 0's.
if (description.Props & renoir::IMP_ClearOnInit)
{
	dataLen = description.Width * description.Height * (renoir::BitsPerPixel(description.Format) / 8);
	empty = dxVector<unsigned char>(dataLen, 0);
	data = empty.data();
}
…