ink

User Guide

  • Quick Start
    • Installation
    • Hello ink
    • Frame Cycle
    • Text Rendering
  • Backend Selection
    • Available Backends
    • CPU Backend
    • OpenGL Backend
    • Metal Backend
    • Fallback Behavior
  • Multi-Layer Compositing
    • Basic Compositing
    • Transparent Layers
    • GPU Snapshots
  • Building ink
    • Requirements
    • Build Options
    • Common Build Configurations
    • Integration
    • Building Documentation

API Reference

  • API Reference
    • Surface
      • ink::Surface
        • ~Surface()
        • beginFrame()
        • canvas()
        • endFrame()
        • flush()
        • getPixelData()
        • isGPU()
        • makeSnapshot()
        • peekPixels()
        • peekPixels()
        • resize()
        • setGlyphCache()
        • takeRecording()
        • MakeGpu()
        • MakeRaster()
        • MakeRasterDirect()
        • MakeRecording()
    • Canvas
      • ink::Canvas
        • draw()
        • draw()
        • drawPath()
        • drawImageRect()
        • drawImageRect()
        • Canvas()
        • clipPath()
        • clipRect()
        • concat()
        • drawImage()
        • drawLine()
        • drawPolyline()
        • drawText()
        • fillCircle()
        • fillRect()
        • fillRoundRect()
        • getMatrix()
        • restore()
        • rotate()
        • save()
        • scale()
        • setMatrix()
        • strokeCircle()
        • strokeRect()
        • strokeRoundRect()
        • translate()
    • Path
      • ink::Path
        • moveTo()
        • moveTo()
        • lineTo()
        • lineTo()
        • quadTo()
        • quadTo()
        • cubicTo()
        • cubicTo()
        • conicTo()
        • conicTo()
        • close()
        • rLineTo()
        • rQuadTo()
        • rCubicTo()
        • addRect()
        • addOval()
        • addCircle()
        • addRoundRect()
        • addArc()
        • addPoly()
        • addPath()
        • verbs()
        • points()
        • conicWeights()
        • fillRule()
        • setFillRule()
        • bounds()
        • contains()
        • contains()
        • getDirection()
        • direction()
        • isEmpty()
        • countVerbs()
        • countPoints()
        • isConvex()
        • reset()
        • transform()
        • transformed()
        • offset()
        • Verb
        • Path()
      • FillRule
        • Winding
        • EvenOdd
      • PathDirection
        • CW
        • CCW
      • LineCap
        • Butt
        • Round
        • Square
      • LineJoin
        • Miter
        • Round
        • Bevel
      • ink::PathEffect
        • ~PathEffect()
        • filterPath()
      • ink::PathEffects
        • MakeDash()
    • Image
      • ink::Image
        • StorageType
        • backendTextureHandle()
        • format()
        • glTextureId()
        • height()
        • info()
        • isCpuBacked()
        • isGpuBacked()
        • pixels()
        • pixels32()
        • storageType()
        • stride()
        • uniqueId()
        • valid()
        • width()
        • MakeFromBackendTexture()
        • MakeFromGLTexture()
        • MakeFromPixmap()
        • MakeFromPixmapNoCopy()
    • Pixmap
      • ink::Pixmap
        • Pixmap()
        • Pixmap()
        • Pixmap()
        • ~Pixmap()
        • addr()
        • addr()
        • addr32()
        • addr32()
        • addr8()
        • addr8()
        • clear()
        • format()
        • height()
        • info()
        • operator=()
        • operator=()
        • reallocate()
        • reset()
        • rowAddr()
        • rowAddr()
        • stride()
        • valid()
        • width()
        • Alloc()
        • Wrap()
      • ink::PixmapInfo
        • bytesPerPixel()
        • computeByteSize()
        • format
        • height
        • stride
        • width
        • Make()
        • MakeBGRA()
        • MakeRGBA()
      • PixelFormat
        • RGBA8888
        • BGRA8888
    • Recording
      • ink::Recording
        • Recording()
        • accept()
        • arena()
        • colorFilters()
        • dispatch()
        • getColorFilter()
        • getImage()
        • getPath()
        • getShader()
        • images()
        • ops()
        • paths()
        • shaders()
      • ink::Recorder
        • clearClip()
        • clearTransform()
        • drawImage()
        • drawImageRect()
        • drawLine()
        • drawLine()
        • drawPolyline()
        • drawPolyline()
        • drawText()
        • drawText()
        • fillCircle()
        • fillCircle()
        • fillPath()
        • fillRect()
        • fillRect()
        • fillRoundRect()
        • fillRoundRect()
        • finish()
        • reset()
        • setClip()
        • setClipPath()
        • setTransform()
        • strokeCircle()
        • strokeCircle()
        • strokePath()
        • strokeRect()
        • strokeRect()
        • strokeRoundRect()
        • strokeRoundRect()
      • ink::DrawOpArena
        • DrawOpArena()
        • allocate()
        • getMatrix()
        • getPoints()
        • getRectPair()
        • getRoundRect()
        • getString()
        • reset()
        • storeMatrix()
        • storePoints()
        • storeRectPair()
        • storeRoundRect()
        • storeString()
    • Gpu Context
      • ink::GpuContext
        • beginFrame()
        • endFrame()
        • execute()
        • resize()
        • makeSnapshot()
        • setGlyphCache()
        • readPixels()
        • textureId()
        • fboId()
        • ~GpuContext()
        • valid()
    • Glyph Cache
      • ink::GlyphCache
        • ~GlyphCache()
        • ascent()
        • atlasData()
        • atlasDirty()
        • atlasHeight()
        • atlasWidth()
        • drawText()
        • getGlyph()
        • init()
        • lineHeight()
        • markClean()
        • measureText()
        • release()
      • ink::GlyphMetrics
        • advance
        • u0
        • u1
        • v0
        • v1
        • x0
        • x1
        • y0
        • y1
    • Types
      • ink::Point
        • x
        • y
      • ink::Rect
        • h
        • w
        • x
        • y
      • ink::Color
        • a
        • b
        • g
        • r
  • Architecture
    • Overview
    • Core Components
    • Backends
    • Surface Compositing
    • Project Structure
  • Building
    • Quick Start
    • Build Options
    • Build Examples
    • Integration
      • As a CMake subdirectory
      • Manual
    • Requirements
  • Usage
    • Basic Drawing
    • Text Rendering
    • GPU Rendering
    • Paths, Clipping, and Dash Effects
    • Multi-layer Compositing
ink
  • Search

© Copyright 2024, ink contributors.

Built with Sphinx using a theme provided by Read the Docs.