render_backend.h · C++ API · 1/2

KUI_API std::unique_ptr<RenderBackend> createDefault();

virtual ~FontHandle() = default;

virtual const String& family() const = 0;

FontHandle(const FontHandle&) = delete;

FontHandle() = default;

FontHandle(FontHandle&&) = delete;

FontHandle& operator=(const FontHandle&) = delete;

FontHandle& operator=(FontHandle&&) = delete;

virtual f32 size() const = 0;

virtual u8 style() const = 0;

virtual u16 weight() const = 0;

virtual ~LottieDecoder() = default;

virtual f64 duration() const = 0;

virtual f64 frameRate() const = 0;

virtual u32 intrinsicHeight() const = 0;

virtual u32 intrinsicWidth() const = 0;

virtual bool isValid() const = 0;

virtual bool loadFromData(const String& jsonData) = 0;

virtual bool loadFromFile(const String& path) = 0;

LottieDecoder(const LottieDecoder&) = delete;

LottieDecoder() = default;

LottieDecoder(LottieDecoder&&) = delete;

LottieDecoder& operator=(const LottieDecoder&) = delete;

LottieDecoder& operator=(LottieDecoder&&) = delete;

virtual bool renderFrame(size_t frameNum, u32* buffer, u32 width, u32 height) = 0;

virtual size_t totalFrames() const = 0;

virtual ~RenderBackend() = default;

virtual FontHandle* acquireFont(const String& family, f32 size, u16 weight, u8 style) = 0;

virtual void addFontFromFile(const String& path, const String& cssFamily, int cssWeight, const String& unicodeRange, f32 sizeAdjust)

virtual void addFontFromFile(const String& path, const String& cssFamily, int cssWeight) = 0;

virtual void addFontFromFile(const String& path, const String& cssFamily, int cssWeight, const String& unicodeRange)

virtual void addFontFromFile(const String& path, const String& cssFamily, int cssWeight, const String& unicodeRange, f32 sizeAdjust, f32 ascentOverride, f32 descentOverride, f32 lineGapOverride)

virtual bool addFontFromSystem(const String& localName, const String& cssFamily, int cssWeight, const String& unicodeRange)

virtual bool addFontFromSystem(const String& localName, const String& cssFamily, int cssWeight)

virtual bool addFontFromSystem(const String& localName, const String& cssFamily, int cssWeight, const String& unicodeRange, f32 sizeAdjust, f32 ascentOverride, f32 descentOverride, f32 lineGapOverride)

virtual bool addFontFromSystem(const String& localName, const String& cssFamily, int cssWeight, const String& unicodeRange, f32 sizeAdjust)

virtual String backendName() const = 0;

virtual void beginFrame() = 0;

virtual bool beginPDFDocument(const String& filePath, const PDFOptions& opts)

virtual bool beginPDFPage(f32 pageWidth_pt, f32 pageHeight_pt)

virtual std::unique_ptr<CanvasImageHandle> borrowGLTextureAsImage( u32 glTextureId, u32 width, u32 height)

virtual void clearDocumentFonts()

virtual void clipRect(const Rect& rect, bool antiAlias = true) = 0;

virtual void clipRoundedRect(const Rect& rect, const CornerRadii& radii, bool antiAlias = true) = 0;

virtual std::vector<WrappedLine> computeWrappedLines( const String& text, FontHandle* font, f32 maxWidth)

virtual std::vector<WrappedLine> computeWrappedLines( const String& text, const String& fontFamily, f32 fontSize, u16 fontWeight, u8 fontStyle, f32 maxWidth) = 0;

virtual std::unique_ptr<CanvasSurface> createCanvasSurface( u32 width, u32 height, bool preferGPU)

virtual std::unique_ptr<CanvasImageHandle> createImageFromPixels( const u8* rgba, u32 width, u32 height)

virtual std::unique_ptr<LottieDecoder> createLottieDecoder()

virtual std::unique_ptr<CanvasSurface> createReplaySurface( u32 width, u32 height, bool preferGPU)

virtual f32 devicePixelRatio() const = 0;

virtual void drawBoxShadow(const Rect& rect, const CornerRadii& radii, const CSSShadow& shadow) = 0;

virtual void drawImage(const String& path, const Rect& src, const Rect& dest) = 0;

virtual void drawSurfaceToFramebuffer(CanvasSurface* surface, const Rect& dst)

virtual void drawSurfaceToFramebufferTransformed( CanvasSurface* surface, const Rect& srcRect, f32 dstOriginX, f32 dstOriginY, const f32 transform44[16], f32 opacity)

virtual void drawText(const String& text, const Point& pos, const String& fontFamily, f32 fontSize, u16 fontWeight, u8 fontStyle, const Color& color) = 0;

virtual void endFrame() = 0;

virtual bool endPDFDocument()

virtual void endPDFPage()

virtual void execute(const DisplayList& displayList) = 0;

virtual void executeOnSurface(CanvasSurface* surface, const DisplayList& displayList, bool clearWhite = true)

virtual void executeOnSurfaceClipped(CanvasSurface* surface, const DisplayList& displayList, bool clearWhite, const std::vector<Rect>& damageRegion)

virtual void fillGradient(const Rect& rect, const CSSGradient& gradient) = 0;

virtual void fillRect(const Rect& rect, const Color& color) = 0;

virtual void fillRoundedRect(const Rect& rect, const CornerRadii& radii, const Color& color) = 0;

virtual void* getCachedImage(const String& path) const = 0;

virtual bool hasAnimatedImages() const = 0;

virtual bool hasPendingImageLoads() const = 0;

virtual void hintSkipNextFramebufferClear()

virtual u32 hitTestPosition(const String& text, f32 xOffset, FontHandle* font)

virtual u32 hitTestPosition(const String& text, f32 xOffset, const String& fontFamily, f32 fontSize, u16 fontWeight, u8 fontStyle) = 0;

virtual bool init(void* nativeWindowHandle, u32 width, u32 height) = 0;

virtual bool isCaptureEnabled() const = 0;

virtual bool isFontFamilyAvailable(const String& cssFamily) const

virtual bool isFontFamilyRegistered(const String& cssFamily) const

virtual bool isImageReady(const String& path) const = 0;

virtual bool isPDFActive() const

virtual std::vector<u8> lastFramePixelsCopy() const = 0;

virtual bool lastFrameRegionPixelsCopy( std::vector<u8>& outPixels, std::vector<FrameCaptureRegion>& outRegions) const

virtual MultiRunResult layoutMultiRunParagraph( std::vector<InlineRun>& runs, f32 availableWidth, u8 textAlign = 0, u32 maxLines = 0, bool ellipsis = false, f32 containerLineHeightMult = -1, TextDirection direction = TextDirection::Ltr, bool allowWordBreak = true, f32 containerFontSize = -1) = 0;