Globals

Classes
struct	AnimationPlayerFlags
	The bit-mask flags of animation player. More...
class	Settings
	Settings. More...
class	Time
	Time. More...

Enumerations
enum	FileKind {   SINGLE_IMAGE, TILE_SHEET_IMAGE, SPRITE_SHEET_IMAGE, SPINE_FILE,   SPRITER_FILE, SPRITE_TEXT_CONTAINER, NOT_DEFINED }
	The kinds of file. More...
enum	SpriteKind {   STANDARD, COMPOSED, TEXT, SPINE,   SPRITER, NOT_DEFINED }
	The kinds of sprite. Used as identifier for Sprite objects. More...
enum	MapType { WORLD, PARALLAX, SCREEN }
	The types of map. More...
enum	LayerKind {   SPRITE, VECTOR, DRAWING, CUSTOM,   NOT_DEFINED }
	The kinds of layer. Used as identifier for Layer objects. More...
enum	LayerType
	The types of layer. Used to distinguish layers for world, parallax and screen maps. More...
enum	StretchingVariant
	The stretching variants. More...
enum	AlignX { LEFT, MIDDLE, RIGHT }
	The align factors for the X direction. More...
enum	AlignY { TOP, MIDDLE, BOTTOM }
	The align factors for the Y direction. More...
enum	Blend {   SOLID, ALPHA, MULTIPLY, ADDITIVE,   NOT_DEFINED }
	The blend modes for the openGL pixel blending. More...
enum	ColorOverlayBlend {   SIMPLE_MULTIPLY, NORMAL, MULTIPLY, LINEAR_DODGE,   COLOR, NOT_DEFINED }
	The blend modes for the shader based pixel blending which simulate photoshop blending modes. More...
enum	FontKind { TRUE_TYPE , NOT_DEFINED }
	The kinds of font. More...
enum	ShapeKind {   POLYLINE, BEZIER_POLYCURVE, ELLIPSE, SINGLE_POINT,   NOT_DEFINED }
	The kinds of geometric shape. Used as identifier for GeometricShape and VectorShape objects. More...
enum	AnimationKind { FRAME_ANIMATION = 0, TIMELINE_ANIMATION = 1 }
	The kinds of animation. Used as identifier for Animation objects. More...
enum	AnimationTrackKind {   TRANSLATION, SCALING, ROTATION, ALPHA_CHANGE,   OVERLAY_COLOR_CHANGE, PATH_MOVEMENT, FRAME_CHANGE, FRAME_ANIMATION,   TIMELINE_ANIMATION, FLIP_HIDE, META, NOT_DEFINED }
	The kinds of animation track. Used as identifier for AnimationTrack and AnimationKey classes. More...
enum	AnimationPlayerState {   IDLE, PLAYING, STALLED, PAUSED,   WAITING_TO_START, WAITING_TO_REPEAT }
	The states of animation player. More...
enum	GuiWidgetKind { ,   BUTTON, SLIDER, BAR, TEXT_FIELD,   TEXT_INPUT }
	The kinds of widget. Used as identifier for GuiWidget objects. More...
enum	TextHandleVariant
	Predefined handles for TextSprite objects. More...
enum	Engine
	Engine identification value. More...

Functions
Vec2f	GetRelativeHandleFromTextHandleVariant (TextHandleVariant _thv)
	Convert TextHandleVariant to relative handle with coordinates in range 0 - 1.0. More...
void	DeleteGlobalObjects ()

Variables
Settings	settings
	The Settings object. More...

Detailed Description

Enumeration Type Documentation

FileKind

enum FileKind

strong

The kinds of file.

Enumerator
SINGLE_IMAGE	Single image file.
TILE_SHEET_IMAGE	Tile sheet image file.
SPRITE_SHEET_IMAGE	Sprite sheet image file.
SPINE_FILE	Spine file.
SPRITER_FILE	Spriter file.
SPRITE_TEXT_CONTAINER	Container of text sprite source items.
NOT_DEFINED	The file kind not defined.

SpriteKind

enum SpriteKind

strong

The kinds of sprite. Used as identifier for Sprite objects.

Enumerator
STANDARD	Standard sprite - StandardSprite object.
COMPOSED	Composed sprite - ComposedSprite object.
TEXT	Text sprite - TextSprite object.
SPINE	Spine sprite - SkeletonSprite object.
SPRITER	Spriter sprite - SkeletonSprite object.
NOT_DEFINED	The sprite kind not defined.

MapType

enum MapType

strong

The types of map.

Enumerator
WORLD	World map.
PARALLAX	Parallax map.
SCREEN	Screen map.

LayerKind

enum LayerKind

strong

The kinds of layer. Used as identifier for Layer objects.

Enumerator
SPRITE	Sprite layer - SpriteLayer object.
VECTOR	Vector layer - VectorLayer object.
DRAWING	Drawing layer - DrawingLayer object.
CUSTOM	Custom layer.
NOT_DEFINED	The layer kind not defined.

LayerType

enum LayerType

strong

The types of layer. Used to distinguish layers for world, parallax and screen maps.

StretchingVariant

enum StretchingVariant

strong

The stretching variants.

AlignX

enum AlignX

strong

The align factors for the X direction.

Enumerator
LEFT	Align left.
MIDDLE	Align to middle.
RIGHT	Align right.

AlignY

enum AlignY

strong

The align factors for the Y direction.

Enumerator
TOP	Align top.
MIDDLE	Align to middle.
BOTTOM	Align bottom.

Blend

enum Blend

strong

The blend modes for the openGL pixel blending.

Enumerator
SOLID	Solid (cover) blend.
ALPHA	Alpha blend.
MULTIPLY	Multiply (darken) blend.
ADDITIVE	Additive (lighten) blend.
NOT_DEFINED	The blend not defined.

ColorOverlayBlend

enum ColorOverlayBlend

strong

The blend modes for the shader based pixel blending which simulate photoshop blending modes.

Enumerator
SIMPLE_MULTIPLY	Simple multiply (not a real blending).
NORMAL	Normal mode.
MULTIPLY	Multiply mode.
LINEAR_DODGE	Linear dodge mode.
COLOR	Color mode.
NOT_DEFINED	The blend not defined.

FontKind

enum FontKind

strong

The kinds of font.

Enumerator
TRUE_TYPE	True type font.
NOT_DEFINED	The font kind not defined.

ShapeKind

enum ShapeKind

strong

The kinds of geometric shape. Used as identifier for GeometricShape and VectorShape objects.

Enumerator
POLYLINE	Polyline - PolyLineShape object.
BEZIER_POLYCURVE	Bezier polycurve - BezierShape object.
ELLIPSE	Ellipse - EllipseShape object.
SINGLE_POINT	Single point - SinglePointShape object.
NOT_DEFINED	The shape kind not defined.

AnimationKind

enum AnimationKind

strong

The kinds of animation. Used as identifier for Animation objects.

Enumerator
FRAME_ANIMATION	Frame animation - FrameAnimation object.
TIMELINE_ANIMATION	Timeline animation - TimelineAnimation object.

AnimationTrackKind

enum AnimationTrackKind

strong

The kinds of animation track. Used as identifier for AnimationTrack and AnimationKey classes.

Enumerator
TRANSLATION	Translation.
SCALING	Scaling.
ROTATION	Rotation.
ALPHA_CHANGE	Alpha change.
OVERLAY_COLOR_CHANGE	Overlay color change.
PATH_MOVEMENT	Path movement.
FRAME_CHANGE	Frame change.
FRAME_ANIMATION	Frame animation.
TIMELINE_ANIMATION	Timeline animation.
FLIP_HIDE	Flip, hide.
META	Meta.
NOT_DEFINED	Not defined.

AnimationPlayerState

enum AnimationPlayerState

strong

The states of animation player.

Enumerator
IDLE	The player is idle and has assigned no animation instance.
PLAYING	The player is playing and updating animation instance.
STALLED	The player is playing but animation instance is not being updated. This a case when an animation is not being looped and remains in its end state.
PAUSED	The player has been paused.
WAITING_TO_START	The player is waiting to start animation due to the startDelay parameter.
WAITING_TO_REPEAT	The player is waiting to repeat animation due to the repeat parameter.

GuiWidgetKind

enum GuiWidgetKind

strong

The kinds of widget. Used as identifier for GuiWidget objects.

Enumerator
BUTTON	Button - GuiButton object.
SLIDER	Slider - GuiSlider object.
BAR	Bar - GuiBar object.
TEXT_FIELD	Text field - GuiTextField object.
TEXT_INPUT	Text input - GuiTextInput object.

TextHandleVariant

enum TextHandleVariant

strong

Predefined handles for TextSprite objects.

Engine

enum Engine

strong

Engine identification value.

Function Documentation

GetRelativeHandleFromTextHandleVariant()

Vec2f GetRelativeHandleFromTextHandleVariant

(

TextHandleVariant

_thv

)

Convert TextHandleVariant to relative handle with coordinates in range 0 - 1.0.

DeleteGlobalObjects()

void DeleteGlobalObjects

(

)

Delete global jugimap objects.

This function must be called at the application exits.

Variable Documentation

settings

Settings settings

The Settings object.