Release notes

What’s new #

Core #

External Profile Markers

Accessing Gameface profile markers #

Gameface now allows external code to hook into its profiling markers. User code can setup handler that will be called when Gameface is profiled and receive information on internal profiling events. This makes displaying profiling markers in external tools and/or systems. More information can be found in the Profiling documentation page. The documentation also illustrates how can Tracy can be used to profile Gameface

Public API Changes #

As part of the feature, there are also a few notable public API changes to Gameface:

• cohtml::Library::EnableProfiling should be used instead of cohtml::System::EnableProfiling.
• cohtml::LibraryParamsWithExternalRenderingLibrary::FileSystemWriter should be used instead of cohtml::SystemSettings::FileSystemWriter
• cohtml::IProfileMarkersTracer and cohtml::LibraryParamsWithExternalRenderingLibrary::ProfileMarkersTracer can be used by client code to receive profiling events from Gameface

Migration guide #

Changes to the renoir::RendererBackend interface #

• In this release, we have added a new rendering backend resource operation, void CopyTextureToTexture(Texture2DObject source, Texture2DObject destination, UpdateBox sourceRect, float2 destinationPoint);, to the renoir::RendererBackend interface. The idea behind it is to copy a region from one texture into a region of another texture. The sourceRect represents the region we wish to copy from the source texture, while the destinationPoint refers to the upper left corner of the destination region. The source and destination region are of the same size which is represented by sourceRect.Right - sourceRect.Left for the width and sourceRect.Bottom - sourceRect.Top for the height. The provided backends offer a reference implementation of the new method.

• An existing renoir::RendererBackend method, void UpdateTexture(Texture2DObject texture, const Texture2D& description, UpdateBox* boxes, const void** newBytes, unsigned count, bool willOverwrite), has been slightly altered. It is known that newBytes is a list of pointers with the new data, with which the texture will be updated, however now if any pointer from this list is nullptr, its corresponding region should be cleared.

If you are using a custom backend, you will have to implement these changes on your end as well.

Text atlas texture size change #

The minimum allowed text atlas texture size has been increased from 64px to 1024px due to internal refactoring of our font loading scheme. If you are using the TextAtlasWidth or TextAtlasHeight initialization parameters of the Rendering library to set a custom size, the value will now be clamped between 1024px and 8192px, rounded up to the nearest power of two.

Changelog #

Version 1.57.0.2 #