Settings API Reference Scenic v0.11.2

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

Manages static assets, which are resources such as fonts or images (jpg or png) that ship with your application and do not change over time.

Manage streaming assets (for now only compressed images and bitmaps) that are available to all Scenes and ViewPorts.

This module helps you to prepare images, in the form of a bitmap, that are to be streamed and displayed through the Scenic.Assets.Stream module.

This module helps you to prepare images, in the form of a compressed blob such as a jpg or png file, that are to be streamed and displayed through the Scenic.Assets.Stream module.

APIs to create and work with colors.

A Component is Scene that is optimized to be used as a child of 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

About Components

Components are small scenes that are managed, by another scene. They are useful for reusing bits of UI and containing the logic that runs them.

The main module for drawing and user input.

Behaviour and support functions for mapping physical keys to characters.

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.

Add a child component to a graph.

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 a draw script.

Draw an sector on the screen.

Draw one or more sprites from a single source image.

Modify the look of a primitive by applying a Style.

Set how to draw the end of a line.

Fill primitives with the specified paint.

Set the font used to draw text.

The point-size to draw text in.

Flags whether or not to draw a primitive.

Flags whether or not track cursor_button events on this primitive.

Set how to connect two lines in a path.

Adjust the vertical spacing of lines of text in a single block.

Automatically miter joints if they are too sharp.

Paint is used to "fill" the area of primitives.

Fill a primitive with a single color

Fill a primitive with an image from Scenic.Assets.Static

Fill a primitive with a linear gradient between two colors

Fill a primitive with a radial gradient between two colors

Fill a primitive with an image or bitmap from Scenic.Assets.Stream

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

Draw an outline around a primitive with the given paint.

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

Set the vertical alignment of text.

Themes are a way to bundle up a set of colors that are intended to be used by 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.

Scenic.PubSub is a combination pub/sub server and data cache.

overview

Overview

Scenes are the core of the UI model.

overview-1

Overview

Scenic.Script is the fundamental "rendering" data structure for Scenic.

overview-2

Overview

The job of the ViewPort is to coordinate the flow of information between the scenes and the drivers. Scenes and Drivers should not know anything about each other. An app should work identically from its point of view no matter if there is one, multiple, or no drivers currently running.

The low-level interface for working in input into and out of a ViewPort.

Starts the application