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

  • 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()
      • Canvas()
      • clipRect()
      • concat()
      • drawImage()
      • drawLine()
      • drawPolyline()
      • drawText()
      • fillCircle()
      • fillRect()
      • fillRoundRect()
      • getMatrix()
      • restore()
      • rotate()
      • save()
      • scale()
      • setMatrix()
      • strokeCircle()
      • strokeRect()
      • strokeRoundRect()
      • translate()
  • Image
    • ink::Image
      • StorageType
        • CpuPixmap
        • GpuTexture
      • 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()
      • dispatch()
      • getImage()
      • images()
      • ops()
    • ink::Recorder
      • clearClip()
      • clearTransform()
      • drawImage()
      • drawLine()
      • drawLine()
      • drawPolyline()
      • drawPolyline()
      • drawText()
      • drawText()
      • fillCircle()
      • fillCircle()
      • fillRect()
      • fillRect()
      • fillRoundRect()
      • fillRoundRect()
      • finish()
      • reset()
      • setClip()
      • setTransform()
      • strokeCircle()
      • strokeCircle()
      • strokeRect()
      • strokeRect()
      • strokeRoundRect()
      • strokeRoundRect()
    • ink::DrawOpArena
      • DrawOpArena()
      • allocate()
      • getMatrix()
      • getPoints()
      • getRoundRect()
      • getString()
      • reset()
      • storeMatrix()
      • storePoints()
      • 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
ink
  • Search

© Copyright 2024, ink contributors.

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