Skip to content

KernelAPI reference

Class StartScreen

Namespace: MicroEngine.Core
Assembly: MicroEngine.dll
Guide: Game lifecycle and time

The screen a game opens on while it loads: its start-screen image (MicroEngineSplashImage, by default the icon) centred on its colour (MicroEngineSplashColor), and “Made with MicroEngine” below when the game asks for it (MicroEngineSplashBranding). Phones and browsers show the same image and colour before the engine starts (launch screens, the loading page), so the player sees one continuous screen from the tap to the first frame. GameLoop draws it once, before Load, on platforms that run in real time; it adds no delay, and an error while loading is reported as before.

C#
public static class StartScreen

Inheritance

object ← StartScreen

Fields

Branding

The text shown when the game turns branding on.

C#
public const string Branding = "Made with MicroEngine"

Field Value

string

Methods

Draw(IRenderer, IGraphicsDevice, AppIdentity)

Draws the start screen of identity into r; textures made from graphics are released before it returns.

C#
public static void Draw(IRenderer r, IGraphicsDevice graphics, AppIdentity identity)

Parameters

r IRenderer

graphics IGraphicsDevice

identity AppIdentity

ImageSize(PixelImage, int, int)

The image size on a canvasWidth by canvasHeight canvas: half the shorter side, in whole pixels, keeping the image’s shape.

C#
public static (int Width, int Height) ImageSize(PixelImage image, int canvasWidth, int canvasHeight)

Parameters

image PixelImage

canvasWidth int

canvasHeight int

Returns

(int Width, int Height)