Inheritance diagram for RootDisplay:

Collaboration diagram for RootDisplay:

Public Member Functions
bool	process (InputEvents *event)
	process any input that is received for this element More...

void	render (Element *parent)
	display the current state of the display More...

void	update ()

int	mainLoop ()

void	initMusic ()

void	startMusic ()

void	setScreenResolution (int width, int height)

void	recycle ()

void	requestQuit ()

Public Member Functions inherited from Element
virtual bool	process (InputEvents *event)
	process any input that is received for this element More...

virtual void	render (Element *parent)
	display the current state of the display More...

bool	onTouchDown (InputEvents *event)

bool	onTouchDrag (InputEvents *event)

bool	onTouchUp (InputEvents *event)

void	hide ()

void	unhide ()

void	renderBackground (bool fill=true)

void	append (Element *element)

void	remove (Element *element)

void	removeAll (bool moveToTrash=false)

void	position (int x, int y)
	position the element More...

void	recalcPosition (Element *parent)

CST_Rect	getBounds ()

CST_Renderer *	getRenderer ()

void	wipeAll (bool delSelf=false)

Element *	child (Element *child)

Element *	setPosition (int x, int y)

Element *	setAction (std::function< void()> func)

Element *	centerHorizontallyIn (Element *parent)

Element *	centerVerticallyIn (Element *parent)

Element *	centerIn (Element *parent)

Element *	setAbsolute (bool isAbs)

Element *	constrain (int flags, int padding=0)

Element *	animate (int durationIn, std::function< void(float)> onStep, std::function< void()> onFinish)

Element *	moveToFront ()

Element *	setTouchable (bool touchable)

void	screenshot (std::string path)
	Take a screenshot of this element and its children, and save it to the given path. More...

Static Public Member Functions
static void	switchSubscreen (Element *next)

Public Attributes
bool	canUseSelectToExit = false

int	lastFrameTime = 99

SDL_Event	needsRender

InputEvents *	events = NULL

std::function< void()>	windowResizeCallback = NULL

std::vector< Element * >	trash

Mix_Music *	music = NULL

Public Attributes inherited from Element
std::function< void()>	action = NULL
	the action to call (from binded callback) on touch or button selection https://stackoverflow.com/questions/14189440/c-class-member-callback-simple-examples More...

std::function< void(InputEvents *event)>	actionWithEvents = NULL

std::vector< Element * >	elements
	visible GUI child elements of this element More...

float	scale = 1.0f

bool	touchable = false
	whether or not this element can be touched (highlights bounds) More...

bool	dragging = false
	whether or not this element is currently being dragged More...

bool	needsRedraw = false
	whether or not this element needs the screen redrawn next time it's processed More...

int	futureRedrawCounter = 0
	whether this element needs a redraw for the next X redraws (decreases each time) (0 is no redraws) More...

int	lastMouseY = 0
	the last Y, X coordinate of the mouse (from a drag probably) More...

int	lastMouseX = 0

bool	hasBackground = false

rgb	backgroundColor = {0, 0, 0}

bool	isAbsolute = false

Element *	parent = NULL
	the parent element (can sometimes be null if it isn't set) More...

bool	hidden = false
	whether this element should skip rendering or not More...

bool	isProtected = false

int	elasticCounter = 0
	how much time is left in an elastic-type flick/scroll set by the last distance traveled in a scroll, and counts down every frame More...

int	width = 0
	width and height of this element (must be manually set, isn't usually calculated (but is in some cases, like text or images)) More...

int	height = 0

int	x = 0

int	y = 0

int	xAbs = 0

int	yAbs = 0

double	angle = 0
	rotation angle in degrees More...

int	xOff = 0

int	yOff = 0

int	cornerRadius = 0

std::vector< Constraint * >	constraints

std::vector< Animation * >	animations

bool	useColorMask = false
	whether or not to overlay a color mask on top of this element More...

CST_Color	maskColor = {0,0,0,0}
	The color to overlay on top. More...

Static Public Attributes
static CST_Renderer *	renderer = NULL

static CST_Window *	window = NULL

static RootDisplay *	mainDisplay = NULL

static Element *	subscreen = NULL

static Element *	nextsubscreen = NULL

static int	screenWidth = 1280

static int	screenHeight = 720

static float	dpiScale = 1.0f

static bool	idleCursorPulsing = false

static bool	isDebug = false

Additional Inherited Members
Public Types inherited from Element
typedef Element	super

Detailed Description

Definition at line 16 of file RootDisplay.hpp.

Constructor & Destructor Documentation

◆ RootDisplay()

RootDisplay::RootDisplay ( )

Definition at line 39 of file RootDisplay.cpp.

{
    // initialize the romfs for switch/wiiu
#if defined(USE_RAMFS)
    ramfsInit();
#endif
    // initialize internal drawing library
    CST_DrawInit(this);
 
    this->x = 0;
    this->y = 0;
    this->width = SCREEN_WIDTH;
    this->height = SCREEN_HEIGHT;
 
    this->hasBackground = true;
 
#ifdef __APPLE__
    chdirForPlatform();
#endif
 
    // set the display scale on high resolution displays
    RootDisplay::dpiScale = CST_GetDpiScale();
 
    // default background color is dark-gray, can be overridden by the implementing library
    this->backgroundColor = fromRGB(30, 30, 30);
 
    // set starting resolution based on SDL version
#if defined(WII) || defined(WII_MOCK)
    setScreenResolution(640, 480);
#elif defined(_3DS) || defined(_3DS_MOCK)
    setScreenResolution(400, 480); // 3ds has a special resolution!
#else
    // setScreenResolution(640, 480);
    setScreenResolution(1280, 720);
#endif
    // the main input handler
    this->events = new InputEvents();
 
    // TODO: initialize this in a way that doesn't block the main thread
    // always load english first, to initialize defaults
    TextElement::loadI18nCache("en-us");
 
    // TODO: detect language and system, and store preference
    // TextElement::loadI18nCache("zh-cn");
}

◆ ~RootDisplay()

RootDisplay::~RootDisplay ( )

virtual

Definition at line 119 of file RootDisplay.cpp.

{
    CST_DrawExit();
 
#if defined(USE_RAMFS)
    ramfsExit();
#endif
}

Member Function Documentation

◆ initMusic()

void RootDisplay::initMusic ( )

Definition at line 85 of file RootDisplay.cpp.

{
#ifdef SWITCH
    // no music if we're in applet mode
    // they use up too much memory, and a lot of people only use applet mode
    AppletType at = appletGetAppletType();
    if (at != AppletType_Application && at != AppletType_SystemApplication) {
        return;
    }
#endif
 
    // Initialize CST_mixer
    CST_MixerInit(this);
}

◆ mainLoop()

int RootDisplay::mainLoop ( )

Definition at line 202 of file RootDisplay.cpp.

{
    DownloadQueue::init();
 
#ifdef __WIIU__
    // setup procui callback for resuming application to force a chesto render
    // https://stackoverflow.com/a/56145528 and http://bannalia.blogspot.com/2016/07/passing-capturing-c-lambda-functions-as.html
    auto updateDisplay = +[](void* display) -> unsigned int {
        ((RootDisplay*)display)->futureRedrawCounter = 10;
        return 0;
    };
    ProcUIRegisterCallback(PROCUI_CALLBACK_ACQUIRE, updateDisplay, this, 100);
 
    // also, register a callback for when we need to quit, to break out the main loop
    // (other platforms will do this directly, but wiiu needs procui to do stuff first)
    auto actuallyQuit = +[](void* display) -> unsigned int {
        ((RootDisplay*)display)->isAppRunning = false;
        return 0;
    };
    ProcUIRegisterCallback(PROCUI_CALLBACK_EXIT, actuallyQuit, this, 100);
#endif
 
    while (isAppRunning)
    {
        bool atLeastOneNewEvent = false;
        bool viewChanged = false;
 
        int frameStart = CST_GetTicks();
 
        // update download queue
        DownloadQueue::downloadQueue->process();
 
        // get any new input events
        while (events->update())
        {
            // process the inputs of the supplied event
            viewChanged |= this->process(events);
            atLeastOneNewEvent = true;
 
            // if we see a minus, exit immediately!
            if (this->canUseSelectToExit && events->pressed(SELECT_BUTTON)) {
                requestQuit();
            }
        }
 
        // one more event update if nothing changed or there were no previous events seen
        // needed to non-input related processing that might update the screen to take place
        if ((!atLeastOneNewEvent && !viewChanged))
        {
            events->update();
            viewChanged |= this->process(events);
        }
 
        // draw the display if we processed an event or the view
        if (viewChanged)
            this->render(NULL);
        else
        {
            // delay for the remainder of the frame to keep up to 60fps
            // (we only do this if we didn't draw to not waste energy
            // if we did draw, then proceed immediately without waiting for smoother progress bars / scrolling)
            int delayTime = (CST_GetTicks() - frameStart);
            if (delayTime < 0)
                delayTime = 0;
            if (delayTime < 16)
                CST_Delay(16 - delayTime);
        }
 
        // free up any elements that are in the trash
        this->recycle();
    }
 
    delete events;
 
    if (!isProtected) delete this;
    DownloadQueue::quit();
 
    return 0;
}

◆ process()

bool RootDisplay::process ( InputEvents * event )

virtual

process any input that is received for this element

Reimplemented from Element.

Definition at line 128 of file RootDisplay.cpp.

{
    if (nextsubscreen != subscreen)
    {
        delete subscreen;
        subscreen = nextsubscreen;
        return true;
    }
 
    // process either the subscreen or the children elements, always return true if "dragging"
    // (may be a mouse cursor or wiimote pointing and moving on the screen)
 
    if (RootDisplay::subscreen)
        return RootDisplay::subscreen->process(event) || event->isTouchDrag();
 
    // keep processing child elements
    return super::process(event) || event->isTouchDrag();
}

References Element::process().

◆ recycle()

void RootDisplay::recycle ( )

Definition at line 282 of file RootDisplay.cpp.

{
    for (auto e : trash)
        e->wipeAll(true);
    trash.clear();
}

◆ render()

void RootDisplay::render ( Element * parent )

virtual

display the current state of the display

Reimplemented from Element.

Definition at line 147 of file RootDisplay.cpp.

{
    if (RootDisplay::subscreen)
    {
        RootDisplay::subscreen->render(this);
        this->update();
        return;
    }
 
    // render the rest of the subelements
    super::render(parent);
 
    // commit everything to the screen
    this->update();
}

References Element::parent, and Element::render().

◆ requestQuit()

void RootDisplay::requestQuit ( )

Definition at line 186 of file RootDisplay.cpp.

{
    // if we've already requested quit, don't proceed
    if (hasRequestedQuit) {
        return;
    }
    hasRequestedQuit = true;
 
    // depending on the platform, either break our loop or (wiiu) switch to the home menu
#ifdef __WIIU__
    SYSLaunchMenu();
#else
    this->isAppRunning = false;
#endif
}

◆ setScreenResolution()

void RootDisplay::setScreenResolution	(	int	width,
		int	height
	)

Definition at line 105 of file RootDisplay.cpp.

{
    // set the screen resolution
    SCREEN_WIDTH = width;
    SCREEN_HEIGHT = height;
 
    // update the root element
    this->width = SCREEN_WIDTH;
    this->height = SCREEN_HEIGHT;
 
    // update the renderer, but respect the DPI scaling
    CST_SetWindowSize(window, SCREEN_WIDTH / RootDisplay::dpiScale, SCREEN_HEIGHT / RootDisplay::dpiScale);
}

◆ startMusic()

void RootDisplay::startMusic ( )

Definition at line 100 of file RootDisplay.cpp.

{
    CST_FadeInMusic(this);
}

◆ switchSubscreen()

void RootDisplay::switchSubscreen ( Element * next )

static

Definition at line 179 of file RootDisplay.cpp.

{
    if (nextsubscreen != subscreen)
        delete nextsubscreen;
    nextsubscreen = next;
}

◆ update()

void RootDisplay::update ( )

Definition at line 163 of file RootDisplay.cpp.

{
    // never exceed 60fps because there's no point
    // commented out, as if render isn't called manually,
    // the CST_Delay in the input processing loop should handle this
 
    //  int now = CST_GetTicks();
    //  int diff = now - this->lastFrameTime;
 
    //  if (diff < 16)
    //      return;
 
    CST_RenderPresent(this->renderer);
    //  this->lastFrameTime = now;
}

Member Data Documentation

◆ canUseSelectToExit

bool RootDisplay::canUseSelectToExit = false

Definition at line 52 of file RootDisplay.hpp.

◆ dpiScale

float RootDisplay::dpiScale = 1.0f

static

Definition at line 44 of file RootDisplay.hpp.

◆ events

InputEvents* RootDisplay::events = NULL

Definition at line 58 of file RootDisplay.hpp.

◆ idleCursorPulsing

bool RootDisplay::idleCursorPulsing = false

static

Definition at line 49 of file RootDisplay.hpp.

◆ isDebug

bool RootDisplay::isDebug = false

static

Definition at line 51 of file RootDisplay.hpp.

◆ lastFrameTime

int RootDisplay::lastFrameTime = 99

Definition at line 54 of file RootDisplay.hpp.

◆ mainDisplay

RootDisplay * RootDisplay::mainDisplay = NULL

static

Definition at line 35 of file RootDisplay.hpp.

◆ music

Mix_Music* RootDisplay::music = NULL

Definition at line 68 of file RootDisplay.hpp.

◆ needsRender

SDL_Event RootDisplay::needsRender

Definition at line 55 of file RootDisplay.hpp.

◆ nextsubscreen

Element * RootDisplay::nextsubscreen = NULL

static

Definition at line 39 of file RootDisplay.hpp.

◆ renderer

CST_Renderer * RootDisplay::renderer = NULL

static

Definition at line 33 of file RootDisplay.hpp.

◆ screenHeight

int RootDisplay::screenHeight = 720

static

Definition at line 43 of file RootDisplay.hpp.

◆ screenWidth

int RootDisplay::screenWidth = 1280

static

Definition at line 42 of file RootDisplay.hpp.

◆ subscreen

Element * RootDisplay::subscreen = NULL

static

Definition at line 38 of file RootDisplay.hpp.

◆ trash

std::vector<Element*> RootDisplay::trash

Definition at line 62 of file RootDisplay.hpp.

◆ window

CST_Window * RootDisplay::window = NULL

static

Definition at line 34 of file RootDisplay.hpp.

◆ windowResizeCallback

std::function<void()> RootDisplay::windowResizeCallback = NULL

Definition at line 60 of file RootDisplay.hpp.

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

src/RootDisplay.hpp
src/RootDisplay.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RootDisplay()

◆ ~RootDisplay()

Member Function Documentation

◆ initMusic()

◆ mainLoop()

◆ process()

◆ recycle()

◆ render()

◆ requestQuit()

◆ setScreenResolution()

◆ startMusic()

◆ switchSubscreen()

◆ update()

Member Data Documentation

◆ canUseSelectToExit

◆ dpiScale

◆ events

◆ idleCursorPulsing

◆ isDebug

◆ lastFrameTime

◆ mainDisplay

◆ music

◆ needsRender

◆ nextsubscreen

◆ renderer

◆ screenHeight

◆ screenWidth

◆ subscreen

◆ trash

◆ window

◆ windowResizeCallback