DSC Engine
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
DSC::ObjVisual Class Reference

OAM Object graphics handler class
More...

#include <obj_visual.hpp>

Public Member Functions

 ObjVisual (DSC::ObjSize obj_size)
 
Size< char > get_size () const
 
int add_frame (ObjFrame *frame)
 adds a new frame to the visual More...
 
void * get_crt_gfx () const
 gets the current graphics from VRAM More...
 
int set_crt_gfx (int gfx_index)
 sets the id of the current (displayed) frame More...
 
int get_crt_color_depth () const
 
void update ()
 
int add_frameset (int frame_id,...)
 
void set_animation (int frameset_id, bool reset_current_frame=false)
 
void set_animation_ticks (int ticks)
 

Static Public Attributes

static constexpr int FRAMESET_END = -1
 

Detailed Description

OAM Object graphics handler class

Member Function Documentation

◆ add_frame()

int DSC::ObjVisual::add_frame ( ObjFrame frame)

adds a new frame to the visual

Parameters
frameobject frame to be added

◆ get_crt_gfx()

void * DSC::ObjVisual::get_crt_gfx ( ) const

gets the current graphics from VRAM

Returns
pointer to loaded frame graphics

◆ set_crt_gfx()

int DSC::ObjVisual::set_crt_gfx ( int  gfx_index)

sets the id of the current (displayed) frame

Parameters
gfx_indexindex of the intended frame, as present in the frames vector
Returns
color depth of the asset containing the frame

The documentation for this class was generated from the following file: