VVISF- Basic Classes

These are the classes that comprise VVISF. More...

Classes
class	VVISF::ISFAttr
	Describes a single ISF attribute. More...
class	VVISF::ISFDoc
	Describes an "ISF file"- requires an actual file on disk which is parsed. Capable of generating GLSL source code for the various shader types. More...
class	VVISF::ISFPassTarget
	Describes the target of a render pass for an ISF file, stores a number of properties and values specific to this render pass. More...
class	VVISF::ISFScene
	Subclass of GLScene- the primary interface for rendering and interacting with an ISF file. More...
struct	VVISF::ISFVal
	ISFVal describes an ISF value- it has a type (ISFValType) and a type-dependent value. Intended to be immutable. More...
class	VVISF::ISFErr
	The base error class utilized by VVISF. More...

Enumerations
enum	VVISF::ISFValType {   VVISF::ISFValType_None, VVISF::ISFValType_Event, VVISF::ISFValType_Bool, VVISF::ISFValType_Long,   VVISF::ISFValType_Float, VVISF::ISFValType_Point2D, VVISF::ISFValType_Color, VVISF::ISFValType_Cube,   VVISF::ISFValType_Image, VVISF::ISFValType_Audio, VVISF::ISFValType_AudioFFT }
	Enumerates the different kinds of ISF values. More...
enum	VVISF::ISFErrType {   VVISF::ISFErrType_Unknown = 0, VVISF::ISFErrType_MissingResource, VVISF::ISFErrType_MalformedJSON, VVISF::ISFErrType_ErrorLoading,   VVISF::ISFErrType_ErrorParsingFS }
	Enumerates the different kinds of ISF errors. More...

Functions
string	VVISF::StringFromISFValType (const ISFValType &n)
	Returns a string describing the passed value type.
bool	VVISF::ISFValTypeUsesImage (const ISFValType &n)
	Returns a true if the passed value type uses an image for its value.

Detailed Description

These are the classes that comprise VVISF.

• VVISF::ISFDoc
• VVISF::ISFScene
• VVISF::ISFErr and VVISF::ISFErrType
• VVISF::ISFVal
• VVISF::ISFAttr
• VVISF::ISFPassTarget

Enumeration Type Documentation

ISFErrType

enum VVISF::ISFErrType

Enumerates the different kinds of ISF errors.

Enumerator
ISFErrType_Unknown	An unknown error type. Resources required by the ISF file cannot be located.
ISFErrType_MissingResource	The JSON blob that defines the ISF file was malformed.
ISFErrType_MalformedJSON	There was an error loading one of the resources required by the ISF file.
ISFErrType_ErrorLoading	There was an error parsing the JSON blob that defines the ISF file.
ISFErrType_ErrorParsingFS	There was an error compiling the ISF file's GLSL program. Consult the ISFErr's "details" map for more information.

ISFValType

enum VVISF::ISFValType

Enumerates the different kinds of ISF values.

Enumerator
ISFValType_None	No data/unknown value type.
ISFValType_Event	No data, just an event. sends a 1 the next render after the event is received, a 0 any other time it's rendered.
ISFValType_Bool	A boolean choice, sends 1 or 0 to the shader.
ISFValType_Long	Sends a long.
ISFValType_Float	Sends a float.
ISFValType_Point2D	Sends a 2 element vector.
ISFValType_Color	Sends a 4 element vector representing an RGBA color.
ISFValType_Cube	Sends a long- the texture number (like GL_TEXTURE0) of a cubemap texture to pass to the shader.
ISFValType_Image	Sends a long- the texture number (like GL_TEXTURE0) to pass to the shader.
ISFValType_Audio	Sends a long- the texture number (like GL_TEXTURE0) to pass to the shader.
ISFValType_AudioFFT	Sends a long- the texture number (like GL_TEXTURE0) to pass to the shader.