RBC Developer Manual
This manual describes the C implementation for contributors. It is separate from the Tcl command reference generated by Ruff. The interfaces described here are private unless explicitly identified as part of the installed vector API.
The manual covers widget and component lifecycles, vectors and numerical operations, configuration and bindings, mapping and layout, native and document renderers, image processing, shared Tk services, standalone window/photo commands and EPS canvas items. Architecture and header chapters provide context; C references are extracted from maintained source comments by Doxygen and Breathe.
Coverage remains selective. A reference entry documents a reviewed contract, not a claim that every function in its module has been audited or made callback safe. Chapters identify current limitations separately from intended guarantees.
Start with Implementation overview and C calling conventions, or select a subsystem below. Expand the sidebar groups directly or follow chapter links here.
Architecture and conventions
Vectors and numerical operations
- Vector ownership and notifications
- Vector client C reference
- Vector C API and storage primitives
- Public versus private entry points
- Registry and creation
- Lookup and borrowed views
- Resizing, resetting and copying
- Protection, publication and destruction
- Callback boundaries and ownership commits
- Post-callback checks and publication
- Observer snapshots and interval scope
- Incremental extrema maintenance
- Variable-trace errors use Tcl object results
- Names, namespaces and access surfaces
- Creation parsers and bounded index strings
- Vector storage public C reference
- Vector storage private C reference
- Vector names, indices and mapped arrays
- Vector access C reference
- Vector instance commands and binary input
- Vector command C reference
- Vector indexed edits and rearrangement
- Vector edit C reference
- Vector queries and numerical generators
- Vector numerical operation C reference
- Vector expression evaluation
- Vector expression C reference
- Expression parser and adapter internals
- Expression engine internal C reference
- Expression reductions and scalar kernels
- Expression numerical C reference
- FFT workspace and output ownership
- FFT and generator C reference
- Spline interpolation and graph smoothing
- Spline C reference
Graphs and components
Graph widget
- Graph lifecycle and redisplay
- Creation and ownership
- Widget option transactions
- Redraw requests and dirty state
- Layout and cancellation
- Frame drawing and presentation
- Destruction
- Contributor checks
- Widget commands and geometry queries
- Screen composition and snapshot capture
- Construction helpers and notification ownership
- Windows metafile layout and ownership
- Graph lifecycle C reference
Axes
- Axis ownership and commands
- Names, references and margin membership
- Configuration boundary
- Dispatch and bindings
- Cleanup and failure recovery
- Option transaction internals
- Ranges and tick generation
- Labels, geometry and presentation
- Margin layout and aspect
- Queries and freshness
- Scrolling state and local views
- Notifications and delivery
- Axis control C reference
Coordinate mapping
Elements
- Element data and dispatch
- Data slots
- Staging and commit
- Updates and invalidation
- Type dispatch and display order
- Destruction
- Synchronous layout before idle notifications
- Transaction records and failure rules
- Original arguments and repeated options
- Retained coordinate representations
- Callback boundaries
- Parsing, allocation and extrema
- Notification metadata and synchronous refresh
- Value-label formatting
- Closest-result source values and traces
- Registry and display-list ownership
- Option initialization and resource lifetime
- Normal, active and export passes
- Command dispatch and query domains
- Binding tokens
- Mutation boundaries
- Closest-search phases
- Line-family geometry ownership
- Line mapping pipeline
- Line-family picking and metadata
- Line symbols and output dispatch
- Line configuration and continuous-run smoothing
- Pen, palette and error-geometry boundaries
- Element data C reference
- Element ownership, data and picking records
- Data slots
- Common data transactions
- Type dispatch signatures
- Configuration transaction internals
- Data observation and value presentation
- Lifecycle and display dispatch
- Commands and binding tags
- Line geometry and resource lifecycle
- Line mapping pipeline
- Line picking and stroke dispatch
- Line symbol and output dispatch
- Line configuration and smoothing
- Shared error-bar geometry
- Data records and member contracts
- Implementation selectors
Pens
Bars
- Bar elements
- Records and ownership
- Creation and configuration
- Grouping keys and passes
- Placement formulas
- Data limits and error translations
- Screen geometry, ownership and output
- Palette grouping and active geometry
- Screen and export dispatch
- Value labels and callbacks
- Cleanup and font changes
- Array and coordinate contracts
- Resource and output contracts
- Bar element C reference
Area fills and error bands
Decimation
Polar graphs
- Polar data and grid geometry
- Source representation and conversion
- Complex-vector ownership
- Polar grid construction
- Smith grid construction
- Integration boundaries
- Parallel parameter ownership and validation
- Current counts versus cached sample storage
- Complex mode selection and cleanup
- Segment cache construction and failure policy
- Label placement in full and cropped views
- Formatter callbacks and cancellation
- Geometry parameter domains and output storage
- Formatter storage and cancellation
- Polar data and geometry C reference
Tracks
- Track ownership and layout
- Records and dependencies
- Configuration and axis ownership
- Sizing and visible bounds
- Local components and dispatch
- Deletion and teardown
- Maintenance checks
- Axis-chain synchronization and option queries
- Sash geometry and scroll fractions
- Notification lifetime boundary
- Dispatch and notification contracts
- Track ownership C reference
Markers
- Marker lifecycle and drawing
- Coordinates and mapping
- Layers, order and visibility
- Window markers
- XOR paths
- Export and cleanup
- Common configuration and ownership
- Coordinate and color parsing
- Creation, replacement and rename
- Bindings, point picking and region searches
- Display-order changes
- Teardown and invalidation details
- Geometric markers: line, polygon and arc
- Bitmap, image, text and window resources
- Pass dispatch and batching
- Marker C reference
- Mapping and output
- Resource and record cleanup
- Internal class interface
- Shared implementation reference
- Line geometry and lifetime
- Polygon and arc geometry and ownership
- Geometric renderer dispatch
- Bitmap marker resources and presentation
- Image marker resources and presentation
- Text marker layout and presentation
- Window marker geometry management and callbacks
- Pass batching and renderer dispatch
- Data records and member contracts
- Implementation selectors
Legends
Grids
Crosshairs
Scrolling
Rendering and document export
- Rendering architecture and contracts
- Module boundaries
- Contexts and capabilities
- Clipping and coordinate rules
- Native details and fallback policy
- Common dispatch and constructor state
- Document ownership
- Validation
- Argument lifetimes and dispatch requirements
- Screen text and raster batches
- Export scopes and completion
- Internal adapter contracts
- Renderer C reference
- Export orchestration and document ownership
- Export orchestration C reference
- Document renderer primitives
- Document renderer C reference
Native renderers
- Native renderer internals
- Component-facing screen operations
- Platform responsibilities
- Backend contract navigation
- Batch lifetime and coordinate conversion
- Polygon and symbol batches
- Rectangular clip frames
- Windows DC clips
- Runs and fallback boundaries
- Shared primitive contracts
- Arc strokes and arrowheads
- X11 request and fallback contracts
- Windows batch eligibility and ownership
- Failure and cleanup boundaries
- Windows compatibility resource boundary
- Monochrome readback and fast paths
- Windows compatibility primitives
- Windows bitmap capture and transforms
- Internal template and buffer contracts
- Retained native geometry contexts
- Shared and X11 native backend C reference
- Windows native backend C reference
Cairo renderer
SVG exporter
PDF exporter
PostScript exporter
- PostScript output and drawing state
- Token ownership
- Prolog and page setup
- Graphics-state boundaries
- Legacy primitive contracts
- Relief rectangles
- Text and fill limitations
- Raster ownership and encoding
- Bitmap acquisition and payloads
- Legacy font selection
- Text transforms and fragment widths
- Graph options and export lifetime
- Page layout and preview paths
- Delivery and ownership
- Maintenance checks
- Parameter and return-value boundaries
- Command arguments and transaction boundaries
- Variable-trace cancellation
- PostScript token C reference
- Persistent graph PostScript configuration
- Token allocation and borrowed buffers
- Appending syntax and loading prologs
- Legacy drawing primitives
- Raster payloads and capture
- Font mapping and text placement
- Graph options and document assembly
- Windows binary preview packaging
- Data records and member contracts
- Implementation selectors
Images, fonts and windows
- Image storage and tile clients
- Image and tile C reference
- Image resizing and resampling
- Image resampling C reference
- Color-image rotation and bitmap transforms
- Image transform C reference
- Image color processing
- Image color processing C reference
- Temporary images and private Tk adapters
- Image compatibility C reference
- Text layout and document fonts
- Layouts borrow the text
- Styles are not universal owners
- Native layout presentation
- Bitmap GC lifetime
- Document-local font resolution
- Native sources and font programs
- Backend integration and cleanup
- Reader trust boundaries
- Unicode and legacy Symbol lookup
- Name-keyed CFF metadata
- SVG cmap reconstruction
- PDF character codes and finalization
- Parameter units and identifier domains
- Choosing a text helper
- Text and font C reference
- Shared drawing and window services
- Shared drawing and window C reference
- Window and photo command implementation
- Window/photo command C reference
- EPS canvas item implementation
- EPS canvas C reference