File GameFramework.h

FileList > engine > include > GameFramework.h

Go to the source code of this file

• #include "InputContext.h"
• #include "DrawContext.h"

Classes

Type	Name
struct	GameFrameworkLayer

Public Types

Type	Name
typedef void(*	DrawFn
enum	GameFrameworkLayerFlags
enum	GameFrameworkLayerType
typedef void(*	InputFn
typedef void(*	OnPopFn
typedef void(*	OnPushFn
typedef void(*	OnWindowDimsChangedFn
typedef void(*	UpdateFn

Public Functions

Type	Name
void	GF_DestroyGameFramework ()
void	GF_DrawGameFramework (DrawContext * context)
void	GF_EndFrame (DrawContext * drawContext, InputContext * inputContext)
struct GameFrameworkLayer *	GF_GetLayerBelow (struct GameFrameworkLayer * pLayer) Returns NULL if no layer below.
void	GF_InitGameFramework ()
void	GF_InputGameFramework (InputContext * context)
void	GF_OnWindowDimsChanged (int newW, int newH)
void	GF_PopGameFrameworkLayer ()
void	GF_PushGameFrameworkLayer (const struct GameFrameworkLayer * layer)
void	GF_UpdateGameFramework (float deltaT)

Macros

Type	Name
define	GF_ANYMASKMASK (MasksInput \| MasksUpdate \| MasksDraw)

Public Types Documentation

typedef DrawFn

typedef void(* DrawFn) (struct GameFrameworkLayer *pLayer, DrawContext *context);

---

enum GameFrameworkLayerFlags

enum GameFrameworkLayerFlags {
    EnableUpdateFn = 1,
    EnableDrawFn = 2,
    EnableInputFn = 8,
    EnableOnPush = 16,
    EnableOnPop = 32,
    MasksDraw = 64,
    MasksUpdate = 128,
    MasksInput = 256
};

---

enum GameFrameworkLayerType

enum GameFrameworkLayerType {
    GFT_Unknown,
    GFT_UI,
    GFT_Game2D
};

---

typedef InputFn

typedef void(* InputFn) (struct GameFrameworkLayer *pLayer, InputContext *context);

---

typedef OnPopFn

typedef void(* OnPopFn) (struct GameFrameworkLayer *pLayer, DrawContext *drawContext, InputContext *inputContext);

---

typedef OnPushFn

typedef void(* OnPushFn) (struct GameFrameworkLayer *pLayer, DrawContext *drawContext, InputContext *inputContext);

---

typedef OnWindowDimsChangedFn

typedef void(* OnWindowDimsChangedFn) (struct GameFrameworkLayer *pLayer, int newW, int newH);

---

typedef UpdateFn

typedef void(* UpdateFn) (struct GameFrameworkLayer *pLayer, float deltaT);

---

Public Functions Documentation

function GF_DestroyGameFramework

void GF_DestroyGameFramework () 

---

function GF_DrawGameFramework

void GF_DrawGameFramework (
    DrawContext * context
) 

---

function GF_EndFrame

void GF_EndFrame (
    DrawContext * drawContext,
    InputContext * inputContext
) 

---

function GF_GetLayerBelow

Returns NULL if no layer below.

struct GameFrameworkLayer * GF_GetLayerBelow (
    struct GameFrameworkLayer * pLayer
) 

---

function GF_InitGameFramework

void GF_InitGameFramework () 

---

function GF_InputGameFramework

void GF_InputGameFramework (
    InputContext * context
) 

---

function GF_OnWindowDimsChanged

void GF_OnWindowDimsChanged (
    int newW,
    int newH
) 

---

function GF_PopGameFrameworkLayer

void GF_PopGameFrameworkLayer () 

---

function GF_PushGameFrameworkLayer

void GF_PushGameFrameworkLayer (
    const struct GameFrameworkLayer * layer
) 

---

function GF_UpdateGameFramework

void GF_UpdateGameFramework (
    float deltaT
) 

---

Macro Definition Documentation

define GF_ANYMASKMASK

#define GF_ANYMASKMASK `(MasksInput | MasksUpdate | MasksDraw)`

---

---

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