Scenic v0.10.0 API Reference

Modules

The Scenic module itself is a supervisor that manages all the machinery that makes the Scenes, ViewPorts, and Drivers run

Base module for static asset caches

In memory cache for static dynamic Image assets

This module is deprecated and has moved Scenic.Cache.Support.Hash

In memory cache for static font assets

In memory cache for static font_metrics assets

In memory cache for static static Image assets

Helpers for reading files in a hash-secured manner

Helper functions to work with hash signatures

Supervisor that starts up and manages the asset caches

A Component is simply a Scene that is optimized to be referenced by another scene

Add a button to a graph

Add a blinking text-input caret to a graph

Add a checkbox to a graph

Add a dropdown to a graph

Add a single radio button to a graph

Add a radio group to a graph

Add a slider to a graph

Add a text field input to a graph

Add toggle to a Scenic graph

About Components

Please see Graph Overview for a high-level description

Helper functions that support Scenic mathematical operations

A collection of functions to work with lines

A collection of functions to work with matrices

Helper functions for working with matrices

A collection of functions to work with 2D vectors

Please see Primitives Overview for a high-level description

Draw an arc on the screen

Draw a circle on the screen

Draw an ellipse on the screen

A container to hold other primitives

Draw a line on the screen

Draw a complex path on the screen described by a list of actions

Draw a quad on the screen

Draw a rectangle on the screen

Draw a rectangle with rounded corners on the screen

A reference to another graph or component

Draw an sector on the screen

Modify the look of a primitive by applying a Style

Set how to draw the end of a line

Set the background color of the entire window/screen

Fill primitives with the specified paint

Set the font used to draw text

Apply a blur effect to text

The point-size to draw text in

Flags whether or not to draw a primitive

Set how to connect two lines in a path

Automatically miter joints if they are too sharp

Paint is used to "fill" the area of primitives

Fill a primitive with a box gradient

Fill a primitive with a single color

Fill a primitive with an image from Scenic.Cache.Dynamic.Texture

Fill a primitive with an image from Scenic.Cache.Static.Texture

Fill a primitive with a linear gradient

Fill a primitive with a radial gradient

Define a "Scissor Rectangle" that drawing will be clipped to

Draw an outline around a primitive with the given paint

Set the alignment of the text with regard to the start point

Set the vertical spacing of lines of text in a single block

The theme style is a way to bundle up default colors that are intended to be used by dynamic components invoked by a scene

Draw text on the screen

Change the position, rotation, scale and more of a primitive

Apply an arbitrary matrix

Set the pin for rotate and scale transforms

Apply a rotation matrix

Apply a scale matrix

Apply a translation matrix

Draw a triangle on the screen

A set of helper functions to make it easy to add to, or modify, a graph

Overview

Overview

Helper module for configuring Drivers during startup

Drivers make up the bottom layer of the Scenic architectural stack. They draw everything on the screen and originate the raw user input. In general, different hardware platforms will need different drivers

Helper module for configuring ViewPorts during startup

Helper module for configuring ViewPorts during startup

The main helpers and organizers for input

The Tables processes is a critical piece of Scenic. It caches the graphs that have been pushed by the various scenes

Exceptions

Mix Tasks

Compute the hash of a file or multiple files in directory

Starts the application