Inheritance diagram for Chesto::RootDisplay:

Collaboration diagram for Chesto::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	requestQuit ()

Public Member Functions inherited from Chesto::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	addNode (std::unique_ptr< Element > node)

void	remove (Element *element)

void	removeAll ()

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

void	recalcPosition (Element *parent)

float	getEffectiveScale () const

CST_Rect	getBounds ()

CST_Renderer *	getRenderer ()

Element *	setPosition (int x, int y)

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

Element *	setAbsolute (bool isAbs)

template<typename T , typename... Args>
T *	createNode (Args &&... args)

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

Element *	constrainToTarget (Element *target, 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	pushScreen (std::unique_ptr< Screen > screen)

static void	popScreen ()

static Screen *	topScreen ()

static void	clearScreens ()

static bool	hasScreens ()

static void	deferAction (std::function< void()> action)

static void	processDeferredActions ()

Public Attributes
bool	canUseSelectToExit = false

int	lastFrameTime = 99

SDL_Event	needsRender

std::unique_ptr< InputEvents >	events

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

Mix_Music *	music = NULL

Public Attributes inherited from Chesto::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< std::unique_ptr< Element, std::function< void(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}

int	backgroundOpacity = 0xff

bool	isAbsolute = false

Element *	parent = nullptr
	the parent element (reference only, not owned) 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	cornerRadius = 0

int	tag = 0

std::vector< std::unique_ptr< Constraint > >	constraints

std::vector< std::unique_ptr< 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 std::vector< std::unique_ptr< Screen > >	screenStack

static std::vector< std::function< void()> >	deferredActions

static bool	isProcessingEvents = false

static int	screenWidth = 1280

static int	screenHeight = 720

static float	dpiScale = 1.0f

static float	globalScale = 1.0f

static bool	idleCursorPulsing = false

static bool	isDebug = false

Additional Inherited Members
Public Types inherited from Chesto::Element
typedef Element	super

Protected Member Functions inherited from Chesto::Element
void	addStackMember (Element *element)

Detailed Description

Definition at line 24 of file RootDisplay.hpp.

Constructor & Destructor Documentation

◆ RootDisplay()

Chesto::RootDisplay::RootDisplay ( )

Definition at line 47 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);
    setScreenResolution(854, 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 = std::make_unique<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");
    
    // Initialize download queue early so it's available during screen construction
    DownloadQueue::init();
}

◆ ~RootDisplay()

Chesto::RootDisplay::~RootDisplay ( )

virtual

Definition at line 210 of file RootDisplay.cpp.

{
    // Clean up screens and root element children before destroying download queue
    // This ensures NetImageElements can cancel downloads properly
    screenStack.clear();
    elements.clear();
    
    // Now safe to destroy download queue
    DownloadQueue::quit();
    
    CST_DrawExit();
 
#if defined(USE_RAMFS)
    ramfsExit();
#endif
}

Member Function Documentation

◆ clearScreens()

void Chesto::RootDisplay::clearScreens ( )

static

Definition at line 167 of file RootDisplay.cpp.

{
    if (isProcessingEvents) {
        // Defer operation until after event processing
        deferAction([]() {
            screenStack.clear();
            if (mainDisplay) mainDisplay->needsRedraw = true;
        });
    } else {
        screenStack.clear();
        if (mainDisplay) mainDisplay->needsRedraw = true;
    }
}

◆ deferAction()

void Chesto::RootDisplay::deferAction ( std::function< void()> action )

static

Definition at line 181 of file RootDisplay.cpp.

{
    // Queue the action to be executed after event processing
    deferredActions.push_back(std::move(action));
}

◆ hasScreens()

bool Chesto::RootDisplay::hasScreens ( )

static

Definition at line 205 of file RootDisplay.cpp.

{
    return !screenStack.empty();
}

◆ initMusic()

void Chesto::RootDisplay::initMusic ( )

Definition at line 97 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 Chesto::RootDisplay::mainLoop ( )

Definition at line 298 of file RootDisplay.cpp.

{
#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())
    {
        isProcessingEvents = true;
        
        // process the inputs of the supplied event
        viewChanged |= this->process(events.get());
        atLeastOneNewEvent = true;
        
        isProcessingEvents = false;
 
        // 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))
        {
            isProcessingEvents = true;
            events->update();
            viewChanged |= this->process(events.get());
            isProcessingEvents = false;
        }
        
        // Event processing done, so run any deferred actions
        processDeferredActions();
 
        // 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);
        }
    }
 
    // unique_ptr will automatically clean up events
    
    return 0;
}

◆ popScreen()

void Chesto::RootDisplay::popScreen ( )

static

Definition at line 148 of file RootDisplay.cpp.

{
    if (isProcessingEvents) {
        // Defer POP until after event processing
        deferAction([]() {
            if (!screenStack.empty()) {
                screenStack.pop_back();
                if (mainDisplay) mainDisplay->needsRedraw = true;
            }
        });
    } else {
        // Safe to execute immediately
        if (!screenStack.empty()) {
            screenStack.pop_back();
            if (mainDisplay) mainDisplay->needsRedraw = true;
        }
    }
}

◆ process()

bool Chesto::RootDisplay::process ( InputEvents * event )

virtual

process any input that is received for this element

Reimplemented from Chesto::Element.

Definition at line 227 of file RootDisplay.cpp.

{
    // 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)
 
    bool result = false;
    
    if (!screenStack.empty()) {
        result = screenStack.back()->process(event) || event->isTouchDrag();
    } else {
        // keep processing child elements
        result = super::process(event) || event->isTouchDrag();
    }
    
    return result;
}

References Chesto::Element::process().

◆ processDeferredActions()

void Chesto::RootDisplay::processDeferredActions ( )

static

Definition at line 187 of file RootDisplay.cpp.

{
    // Execute all deferred actions, on a copy
    auto actionsToRun = std::move(deferredActions);
    deferredActions.clear();
    
    for (auto& action : actionsToRun) {
        if (action) {
            action();
        }
    }
}

◆ pushScreen()

void Chesto::RootDisplay::pushScreen ( std::unique_ptr< Screen > screen )

static

Definition at line 139 of file RootDisplay.cpp.

{
    if (!screen) return;
    
    // PUSHes are not deferred! They go right onto the stack and render immediately
    screenStack.push_back(std::move(screen));
    if (mainDisplay) mainDisplay->needsRedraw = true;
}

◆ render()

void Chesto::RootDisplay::render ( Element * parent )

virtual

display the current state of the display

Reimplemented from Chesto::Element.

Definition at line 244 of file RootDisplay.cpp.

{   
    // if we have a screen stack, render each screen as layers
    if (!screenStack.empty())
    {
        super::render(parent);
        
        for (const auto& screen : screenStack) {
            screen->render(this);
        }
        
        this->update();
        return;
    }
 
    // render the rest of the subelements
    super::render(parent);
 
    // commit everything to the screen
    this->update();
}

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

◆ requestQuit()

void Chesto::RootDisplay::requestQuit ( )

Definition at line 282 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 Chesto::RootDisplay::setScreenResolution	(	int	width,
		int	height
	)

Definition at line 117 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);
 
    RootDisplay::deferAction([]() {
        // inform all screens of the resolution change
        for (auto& screen : screenStack) {
            screen->rebuildUI();
        }
    });
}

◆ startMusic()

void Chesto::RootDisplay::startMusic ( )

Definition at line 112 of file RootDisplay.cpp.

{
    CST_FadeInMusic(this);
}

◆ topScreen()

Screen * Chesto::RootDisplay::topScreen ( )

static

Definition at line 200 of file RootDisplay.cpp.

{
    return screenStack.empty() ? nullptr : screenStack.back().get();
}

◆ update()

void Chesto::RootDisplay::update ( )

Definition at line 266 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 Chesto::RootDisplay::canUseSelectToExit = false

Definition at line 82 of file RootDisplay.hpp.

◆ deferredActions

std::vector< std::function< void()> > Chesto::RootDisplay::deferredActions

static

Definition at line 62 of file RootDisplay.hpp.

◆ dpiScale

float Chesto::RootDisplay::dpiScale = 1.0f

static

Definition at line 71 of file RootDisplay.hpp.

◆ events

std::unique_ptr<InputEvents> Chesto::RootDisplay::events

Definition at line 88 of file RootDisplay.hpp.

◆ globalScale

float Chesto::RootDisplay::globalScale = 1.0f

static

Definition at line 74 of file RootDisplay.hpp.

◆ idleCursorPulsing

bool Chesto::RootDisplay::idleCursorPulsing = false

static

Definition at line 79 of file RootDisplay.hpp.

◆ isDebug

bool Chesto::RootDisplay::isDebug = false

static

Definition at line 81 of file RootDisplay.hpp.

◆ isProcessingEvents

bool Chesto::RootDisplay::isProcessingEvents = false

static

Definition at line 64 of file RootDisplay.hpp.

◆ lastFrameTime

int Chesto::RootDisplay::lastFrameTime = 99

Definition at line 84 of file RootDisplay.hpp.

◆ mainDisplay

RootDisplay * Chesto::RootDisplay::mainDisplay = NULL

static

Definition at line 43 of file RootDisplay.hpp.

◆ music

Mix_Music* Chesto::RootDisplay::music = NULL

Definition at line 95 of file RootDisplay.hpp.

◆ needsRender

SDL_Event Chesto::RootDisplay::needsRender

Definition at line 85 of file RootDisplay.hpp.

◆ renderer

CST_Renderer * Chesto::RootDisplay::renderer = NULL

static

Definition at line 41 of file RootDisplay.hpp.

◆ screenHeight

int Chesto::RootDisplay::screenHeight = 720

static

Definition at line 68 of file RootDisplay.hpp.

◆ screenStack

std::vector< std::unique_ptr< Screen > > Chesto::RootDisplay::screenStack

static

Definition at line 59 of file RootDisplay.hpp.

◆ screenWidth

int Chesto::RootDisplay::screenWidth = 1280

static

Definition at line 67 of file RootDisplay.hpp.

◆ window

CST_Window * Chesto::RootDisplay::window = NULL

static

Definition at line 42 of file RootDisplay.hpp.

◆ windowResizeCallback

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

Definition at line 90 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

◆ clearScreens()

◆ deferAction()

◆ hasScreens()

◆ initMusic()

◆ mainLoop()

◆ popScreen()

◆ process()

◆ processDeferredActions()

◆ pushScreen()

◆ render()

◆ requestQuit()

◆ setScreenResolution()

◆ startMusic()

◆ topScreen()

◆ update()

Member Data Documentation

◆ canUseSelectToExit

◆ deferredActions

◆ dpiScale

◆ events

◆ globalScale

◆ idleCursorPulsing

◆ isDebug

◆ isProcessingEvents

◆ lastFrameTime

◆ mainDisplay

◆ music

◆ needsRender

◆ renderer

◆ screenHeight

◆ screenStack

◆ screenWidth

◆ window

◆ windowResizeCallback