language-servers/slint
1
0
Fork 0
mirror of https://github.com/slint-ui/slint.git synced 2025-10-25 17:38:06 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

c++: Mark experimental target pixel buffer as experimental in the docs

Browse source
This commit is contained in:
Simon Hausmann 2025-02-25 16:52:21 +01:00 • committed by Simon Hausmann
parent 4ec5e43a0a
commit 4d8f99e35d
1 changed files with 14 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

14
api/cpp/include/slint-platform.h
View file

@ -545,6 +545,9 @@ using cbindgen_private::types::TexturePixelFormat;
/// This structure describes the properties of a texture for blending with /// This structure describes the properties of a texture for blending with
/// TargetPixelBuffer::draw_texture(). /// TargetPixelBuffer::draw_texture().
///
/// **Note**: This class is still experimental - it's API is subject to changes and not stabilized
/// yet. To use the class, you must enable the `SLINT_FEATURE_EXPERIMENTAL=ON` CMake option.
struct Texture struct Texture
{ {
/// A reference to the pixel bytes of the texture. These bytes are in the format specified by /// A reference to the pixel bytes of the texture. These bytes are in the format specified by
@ -575,6 +578,9 @@ struct Texture
/// Abstract base class for a target pixel buffer where certain drawing operations can be delegated. /// Abstract base class for a target pixel buffer where certain drawing operations can be delegated.
/// Use this to implement support for hardware accelerators such as DMA2D, PPA, or PXP on /// Use this to implement support for hardware accelerators such as DMA2D, PPA, or PXP on
/// Microcontrollers. /// Microcontrollers.
///
/// **Note**: This class is still experimental - it's API is subject to changes and not stabilized
/// yet. To use the class, you must enable the `SLINT_FEATURE_EXPERIMENTAL=ON` CMake option.
template<typename PixelType> template<typename PixelType>
struct TargetPixelBuffer struct TargetPixelBuffer
{ {
@ -745,6 +751,10 @@ public:
# ifdef SLINT_FEATURE_EXPERIMENTAL # ifdef SLINT_FEATURE_EXPERIMENTAL
/// Renders into the given TargetPixelBuffer. /// Renders into the given TargetPixelBuffer.
///
/// **Note**: This class is still experimental - it's API is subject to changes and not
/// stabilized yet. To use the class, you must enable the `SLINT_FEATURE_EXPERIMENTAL=ON` CMake
/// option.
PhysicalRegion render(TargetPixelBuffer<Rgb8Pixel> *buffer) const PhysicalRegion render(TargetPixelBuffer<Rgb8Pixel> *buffer) const
{ {
cbindgen_private::CppRgb8TargetPixelBuffer buffer_wrapper { cbindgen_private::CppRgb8TargetPixelBuffer buffer_wrapper {
@ -800,6 +810,10 @@ public:
} }
/// Renders into the given TargetPixelBuffer. /// Renders into the given TargetPixelBuffer.
///
/// **Note**: This class is still experimental - it's API is subject to changes and not
/// stabilized yet. To use the class, you must enable the `SLINT_FEATURE_EXPERIMENTAL=ON` CMake
/// option.
PhysicalRegion render(TargetPixelBuffer<Rgb565Pixel> *buffer) const PhysicalRegion render(TargetPixelBuffer<Rgb565Pixel> *buffer) const
{ {
cbindgen_private::CppRgb565TargetPixelBuffer buffer_wrapper { cbindgen_private::CppRgb565TargetPixelBuffer buffer_wrapper {