File XMLUIGameLayer.h

FileList > engine > include > XMLUIGameLayer.h

#include <libxml/tree.h>
#include <stdbool.h>
#include "HandleDefs.h"
#include "DynArray.h"
#include "Widget.h"
#include "DrawContext.h"
#include "TimerPool.h"
#include "InputContext.h"

Classes

Type	Name
struct	WidgetChildrenChangeRequest its a "request" because if an ancenstor of the requesting widget also requests then the request is overruled
struct	XMLUIData
struct	XMLUIGameLayerOptions

Public Types

Type	Name
typedef HWidget(*	AddChildFn Function pointer typedef for adding a new widget, described by pDataNode as a child of hParent should return a handle to the created widget.
typedef struct XMLUIData	XMLUIData

Public Functions

Type	Name
void	XMLUIGameLayer_Get (struct GameFrameworkLayer * pLayer, struct XMLUIGameLayerOptions * pOptions) Get and possibly load (if bLoadImmediately) a ui layer defined by xml.
void	XMLUI_PushGameFrameworkLayer (const char * xmlPath)

Macros

Type	Name
define	MAX_FOCUSED_WIDGETS `16`
define	XML_UI_MAX_PATH `256`

Public Types Documentation

typedef AddChildFn

Function pointer typedef for adding a new widget, described by pDataNode as a child of hParent should return a handle to the created widget.

typedef HWidget(* AddChildFn) (HWidget hParent, struct DataNode *pDataNode, struct XMLUIData *pUILayerData);

typedef XMLUIData

typedef struct XMLUIData XMLUIData;

Public Functions Documentation

function XMLUIGameLayer_Get

Get and possibly load (if bLoadImmediately) a ui layer defined by xml.

void XMLUIGameLayer_Get (
    struct GameFrameworkLayer * pLayer,
    struct XMLUIGameLayerOptions * pOptions
)

Parameters:

pLayer (Out) layer to turn into an xml ui layer
pOptions options for creation

function XMLUI_PushGameFrameworkLayer

void XMLUI_PushGameFrameworkLayer (
    const char * xmlPath
)

Macro Definition Documentation

define MAX_FOCUSED_WIDGETS

#define MAX_FOCUSED_WIDGETS `16`

define XML_UI_MAX_PATH

#define XML_UI_MAX_PATH `256`

The documentation for this class was generated from the following file /home/runner/work/2DFarmingRPG/2DFarmingRPG/Stardew/engine/include/XMLUIGameLayer.h