Release notes

Changelog #

Version 1.25.1.2 #

Migration guide #

Anti-aliased clipping #

Version 1.25 of Prysm introduces anti-aliased clipping (for more details see Anti-Aliased Clipping. This has required some changes to the rendering.

• All backends now support 5 texture slots instead of 4.
• The PerPrimitivePS constant buffer now has a new int field ShouldClip.
• There is a new pixel shader – CohClipMaskPS.hlsl
• There are a few new pixel shader types (renoir::PixelShaderTypes). renoir::PixelShaderTypes::PST_ClippingRect – used for drawing a clip rectangle, renoir::PixelShaderTypes::PST_ClippingCircle – used to drawing clip circle, renoir::PixelShaderTypes::PST_ClippingTexture – used for drawing clip image, and renoir::PixelShaderTypes::PST_ClippingPath – used to draw a clip-path. The handling of these shader types is in the new CohClipMaskPS.hlsl pixel shader.
• There are a few new shader types that all backends are being able to handle – renoir::ShaderType::ST_Clipping, renoir::ShaderType::ST_ClippingRect, renoir::ShaderType::ST_ClippingCircle, renoir::ShaderType::ST_ClippingTexture, and renoir::ShaderType::ST_Clipping::ST_ClippingPath. The handling of these shader types can be seen in the renoir::Dx11Backend backend.

Enhancement of user fonts API #

Previously, the cohtml::UserFontDescription structure contained a Baseline field, which divided the line height into 2 parts. In version 1.25 this field is removed in favor of adding 2 different ones - Ascent and Descent, which are produced by most font authoring tools and provide greater control for the glyph positioning. The Ascent is the part above the baseline and the Descent is the part below. These 2 values may not sum up to the LineHeight - the excess height is the line gap, which is used internally for proper positioning.

The samples and documentation are updated to reflect this change.

• If the tool you’re using for generating user fonts outputs the Ascent and Descent, you can directly use them (ascent is positive and descent is negative).
• If you don’t have those values readily available, you can do an approximation that assumes no line gap using the Baseline value:
  • Ascent = Baseline
  • Descent = Baseline - LineHeight

Compositor API Enhancement #

Version 1.25 of Prysm introduces enhancement of the usage of Compositor (see Compositor.

• unsigned ViewId is added to the renoir::ISublayerCompositor::DrawData structure. With this change, you can have the same composition IDs in different views.
• Likewise, unsigned viewId is added as a parameter to OnCompositionRemoved callback to identify the actual composition for removal

New rendering backend capability #

• There is a new field in the renoir::RendererCaps structure - EndingRenderPassRequiresStateUpdate. The field indicates whether the GPU state should rebound after a render pass has been ended. This is a requirement for some graphics APIs (e.g. Metal) where the driver requires you to update the GPU pipeline state every time after the end of a render pass. The EndingRenderPassRequiresStateUpdate has been added in order not to burden the backend themselves to cache the GPU state and rebind it again after a render pass ends.