Skip to content

Latest commit

 

History

History
65 lines (38 loc) · 1.04 KB

api.rst

File metadata and controls

65 lines (38 loc) · 1.04 KB

API

The API is a python module named pv that allows users to modify the kernel's behavior.

Properties

Properties are just variables, but they can be interpreted by the GUI and displayed properly.

pv.Property

pv.BoolProp

pv.IntProp

pv.FloatProp

pv.StrProp

pv.ListProp

A PropertyGroup is a collection of properties.

pv.PropertyGroup

Data and Cache

The API has a few classes for storing and accessing data.

pv.DataGroup

pv.Cache

Operators

Operators are functions that operate on a video and can be displayed in the GUI.

pv.Operator

Jobs

Jobs modify the rendering process.

pv.Job

Utilities

pv.utils.register_class

pv.utils.add_callback

pv.utils.get

pv.utils.get_index

pv.utils.get_exists