--- title: "API Reference" description: "Every public type and member in NeoGameLib 0.3.2, compact." canonical_url: "https://docs.ctrl-neo.dev/en/neogamelib/api-reference" --- # API Reference Every public type in NeoGameLib 0.3.2, compact. Namespaces: - `NeoGameLib` (root) - `NeoGameLib.Common` - `NeoGameLib.NeoGO` - `NeoGameLib.NeoRendering` - `NeoGameLib.NeoCollision` - `NeoGameLib.NeoInput` - `NeoGameLib.NeoUI` / `NeoGameLib.NeoUI.Elements` - `NeoGameLib.NeoStorage` - `NeoGameLib.FuckingEvents` (see [Systems](https://docs.ctrl-neo.dev/8.systems#eventbus-avoid)) ## NeoGameLib ### class NeoGame : Game

Member	Signature
ctor	`NeoGame()`
`Singleton`	`static NeoGame? Singleton { get; }`
`ViewportAspect`	`float? { get; set; }` — viewport ratio or null; throws on non-positive/non-finite
`LetterboxColor`	`Color { get; set; } = Color.Black`
`ClearColor`	`Color { get; set; } = Color.CornflowerBlue`
`GraphicsDeviceManager`	`GraphicsDeviceManager { get; }`
`RenderBus`	`NeoRenderBus { get; }`
`ColliderBus`	`NeoColliderBus { get; }`
`TimerBus`	`NeoTimerBus { get; }`
`InputBus`	`NeoInputBus { get; }`
`UIBus`	`NeoUIBus { get; }`
`WorldManager`	`WorldManager { get; }`
`Assets`	`AssetManager { get; }`
`GraphicsViewport`	`Viewport { get; }`
`WindowMode`	`NeoWindowMode { get; }`
`ViewportBounds`	`Rectangle { get; }` — window-pixel draw box
`GetScreenCenterCoords()`	`Vector2`
`SetWindowMode(NeoWindowMode mode)`	`void`
hooks	`protected virtual OnInitialize() / OnLoadContent(ContentManager) / OnUpdate(GameTime) / OnDraw(SpriteBatch, GameTime) / OnDrawUI(SpriteBatch, GameTime)`

### class NeoGame : NeoGame where T : NeoGame `public new static T Singleton { get; }` ### enum NeoWindowMode `Windowed`, `Fullscreen`, `BorderlessFullscreen` ## NeoGameLib.Common ### class NeoTimer

Member	Signature
ctor	`NeoTimer(float duration)`
`Duration`	`float { get; set; }`
`TimeLeft`	`float { get; }`
`IsRunning` / `IsPaused`	`bool { get; }`
`OnStart` / `OnStop` / `OnPause` / `OnResume` / `OnFinished`	`Action` fields
`Start()` / `Stop()` / `Pause()` / `Resume()`	`void`

### class NeoTimerBus : NeoBus `void Update(GameTime gameTime)` ### abstract class NeoBus

Member	Signature
`Add(T item)`	`void` — skips existing
`Remove(T item)`	`void`
`Count`	`int`
`Contains(T item)`	`bool`
`RemoveAll(Predicate match)`	`int`

### readonly struct PassSnapshot : IDisposable

Member	Signature
ctor	`PassSnapshot(IReadOnlyList list)`
`Count`	`int`
indexer	`T this[int index]`
`Dispose()`	`void` — returns the rented array to the pool

### abstract class NeoSingleton where T : NeoSingleton `public static T Singleton { get; }` — ctor throws if a second instance is made. ### class NeoMover : NeoComponent

Member	Default	Signature
`KeyUp` / `KeyDown` / `KeyLeft` / `KeyRight` / `KeyJump`	`null`	`Keys?` fields
`Speed`	200	`float` field
`Gravity`	2000	`float` field
`JumpVelocity`	600	`float` field
`Omnidirectional`	true	`bool` field
`UseLerp`	true	`bool` field
`LerpSnappiness`	10	`float` field
`GroundComponentType`	`null`	`Type` field
`Grounded`	—	`bool { get; }`
`CollisionWhitelist` / `CollisionBlacklist`	empty	`List { get; set; }`
`Velocity`	—	`Vector2 { get; }`
`Move(Vector2 direction)`		`void`
`Jump()`		`void` — only grounded
`AddImpulse(Vector2 impulse)`		`void`
`AddToWhitelist()` / `RemoveFromWhitelist()` / `AddToBlacklist()` / `RemoveFromBlacklist()`		`void` where T : NeoComponent

### class AssetManager

Member	Signature
`Load(string path, bool forceLoad = false)`	`T`
`Unload(string path)`	`void` — disposes if `IDisposable`
`UnloadAll()`	`void`

### enum Direction2D `Left`, `Right`, `Up`, `Down` ### static class Direction2DExtensions `ToVector2(this Direction2D) : Vector2`, `Invert(this Direction2D) : Direction2D` ### enum PlayerControlsKeyboardMode `WASDF`, `UHJKL`, `ArrowsShift` — defined, not used anywhere in the library. ## NeoGameLib.NeoGO ### class NeoObject

Member	Signature
ctors	`(string name)` , `(Transform transform)` , `(string name, Transform transform)`
`Name`	`string { get; set; }`
`Transform`	`Transform { get; set; }` — setter copies fields
`Components`	`List { get; }`
`World`	`NeoWorld { get; internal set; }`
`IsDestroyed`	`bool { get; }`
`AddComponent()` / `AddComponent(T component)`	`T`
`GetComponent()`	`T` (null if absent)
`TryGetComponent(out T)`	`bool`
`HasComponent()` / `HasComponent(Type)`	`bool`
`RemoveComponent(NeoComponent)` / `RemoveComponent()`	`bool`
`OnInstantiate()`	`virtual void`
`DestroyToQueue()`	`void`
`DestroyImmediate()`	`void`
`Tick(GameTime)`	`void` (called by the world)

### abstract class NeoComponent

Member	Signature
`ParentObject`	`NeoObject { get; }`
`ParentTransform`	`Transform { get; }`
`ParentWorld`	`NeoWorld { get; }`
`Assets` / `WorldManager` / `RenderBus` / `ColliderBus` / `TimerBus` / `InputBus`	manager shorthands (`null` before game init)
`Enabled`	`bool { get; set; }` = true
`IsAttached`	`bool { get; }`
`HasRanOnStart`	`bool` field
`OnAwake()` / `OnStart()` / `OnUpdate(GameTime)` / `OnDestroy()`	`virtual void`

### class NeoWorld

Member	Signature
ctor	`(string name)`
`Name`	`string { get; internal set; }`
`Objects`	`List { get; }`
`Instantiate(string name)`	`NeoObject`
`Instantiate(string name, Vector2 position)`	`NeoObject`
`Instantiate(string name, Transform transform)`	`NeoObject`
`Instantiate(T obj)` / `(T obj, Vector2)` / `(T obj, Transform)`	`T where T : NeoObject`
`Destroy(NeoObject obj)`	`void` (queued)
`Update(GameTime)`	`void`
`Clear()`	`void` — destroy all objects now
`FindObjectByHashCode(int)` / `FindObjectByComponent()` / `FindObjectByName(string)`	`NeoObject?`
`FindObjectsByName(string)` / `FindObjectsByComponent()`	`List`
`FindComponent()`	`T`
`FindComponents()`	`List`
`TryFind...` variants of the above	`bool` + `out`

### class WorldManager

Member	Signature
`LoadedWorlds`	`List { get; }`
`CreateWorld(string name, Action build = null)`	`NeoWorld` — throws on duplicate
`CreateWorld(NeoWorld world, Action build = null)`	`NeoWorld`
`Load(string name)`	`NeoWorld`
`Unload(string name)`	`bool`
`UnloadAll()`	`void`
`GetWorld(string name)` / `this[string name]` / `TryGetWorld(string, out NeoWorld)`	`NeoWorld` / `bool`
`IsLoaded(string name)`	`bool`
`RenameWorld(string name, string newName)`	`void`
`GroupCollisions(string groupName, params string[] worldNames)`	`void`
`UngroupCollisions(string worldName)`	`void`
`Update(GameTime)`	`void`

### class Transform

Member	Signature
ctors	`()` , `(Vector2 pos, float rot = 0)` , `(Vector2 pos, Vector2 scale)`
`Position`	`Vector2 { get; set; }`
`Rotation`	`float { get; set; }` (radians)
`Scale`	`Vector2 { get; set; }` = (1,1)
`Up` / `Down` / `Right` / `Left`	`Vector2 { get; }`
`Move(Vector2 direction, GameTime)`	`void`
`FaceTowards(Direction2D side, Vector2 \| Transform \| NeoObject target)`	`void`

## NeoGameLib.NeoRendering ### class NeoRenderBus

Member	Signature
ctor	`(GraphicsDeviceManager)`
`GraphicsViewport`	`Viewport { get; }`
`Cameras`	`IReadOnlyList { get; }`
`MainCamera`	`NeoCamera { get; }`
`HasAnyCamera`	`bool { get; }`
`ViewMatrix`	`Matrix { get; }`
`WorldToScreen(Vector2 world)`	`Vector2` — window pixels, main camera
`ScreenToWorld(Vector2 screen)`	`Vector2`
`Draw(SpriteBatch)`	`void` — identity pass
`Draw(SpriteBatch, NeoCamera)`	`void` — camera pass (culling mask)
`AddSprite` / `RemoveSprite` / `AddText` / `RemoveText`	registration plumbing; renderers self-register in `OnAwake` , no manual calls needed

### class NeoSpriteRenderer : NeoComponent

Member	Default	Signature
ctor		`(NeoRenderBus bus, Texture2D? texture = null)`
`Texture`	null	`Texture2D { get; set; }`
`SourceRectangle`	null	`Rectangle? { get; set; }`
`Color`	White	`Color { get; set; }`
`Depth`	0	`float { get; set; }` — higher = behind
`Anchor`	(0.5, 0.5)	`Vector2 { get; set; }`
`Order`	auto	`int { get; set; }`
`Layer`	1	`int { get; set; }` — culling bitmask
`Bounds`	—	`Rectangle { get; }`
`ScreenBounds`	—	`Rectangle { get; }`
`WithinViewportBounds` / `VisibleInViewportBounds`	—	`bool { get; }`
`IsOverWindowBounds(Direction2D)`		`virtual bool`
`ContainsScreenPoint(Vector2)`		`bool`
`IsCursorOnSprite()`		`bool`

### class NeoCamera : NeoComponent

Member	Signature
ctor	`(NeoRenderBus bus)`
`Zoom`	`float { get; set; }` = 1 — invalid values rejected silently
`Order`	`int { get; set; }`
`CullingMask`	`int { get; set; }` = -1
`GetViewMatrix(Viewport)`	`Matrix`
`WorldToScreen(Vector2, Viewport)` / `ScreenToWorld(Vector2, Viewport)`	`Vector2` — viewport-local

### class NeoTextRenderer : NeoComponent `ctor(NeoRenderBus bus, SpriteFont? font = null)`; `Font`, `Text` ("") `Color` (White), `Depth` (0), `Anchor` (0.5,0.5), `Order` (auto), `Layer` (1). ### class NeoAnimation

Member	Signature
ctor	`(List frames, float frameDuration, bool loop = true, bool holdLastFrame = true)`
`Frames`	`List { get; }`
`FrameDuration`	`float { get; }`
`Loop` / `HoldLastFrame`	`bool { get; }`
`FromGrid(...)`	`static NeoAnimation FromGrid(Point gridSize, Point cellSize, float frameDuration, bool loop = true, Direction2D horizontal = Right, Direction2D vertical = Down, Point padding = default, Point margin = default, bool horizontalFirst = true, bool holdLastFrame = true)`

### class NeoAnimator : NeoComponent `Play(NeoAnimation)`, `Stop()`, `OnAnimationFinished` (`Action`), `CurrentFrameIndex` (`int { get; }`). Requires a `NeoSpriteRenderer` on the same object (throws in `OnAwake` otherwise); null/empty animation throws in `Play`. ### abstract class NeoSpriteRenderFeature : NeoComponent `Renderer` (`NeoSpriteRenderer { get; }`); `virtual OnDrawBehind(SpriteBatch, in NeoSpriteDrawInfo)`, `virtual OnDrawFront(SpriteBatch, in NeoSpriteDrawInfo)`, `protected virtual OnFeatureAwake()`, `protected virtual OnFeatureDestroy()`. Requires a `NeoSpriteRenderer` on the same object (throws otherwise). ### readonly struct NeoSpriteDrawInfo `Texture`, `SourceRectangle`, `Position`, `Color`, `Rotation`, `Origin`, `Scale`, `Effects`, `Depth` (all get-only); `void Draw(SpriteBatch, Texture2D, Color, Vector2 offset = default)`. ### class NeoOutlineFeature : NeoSpriteRenderFeature `Color` (White), `Thickness` (2f, world pixels). Needs a non-compressed `SurfaceFormat.Color` texture for the silhouette. ## NeoGameLib.NeoCollision ### class NeoBoxCollider : NeoComponent

Member	Default	Signature
`Offset`	(0, 0)	`Vector2 { get; set; }`
`Size`	(1, 1)	`Vector2 { get; set; }`
`Bounds`	—	`virtual Rectangle { get; }` — world-space, scale-aware, rotation ignored

### class NeoSpriteCollider : NeoBoxCollider `override Rectangle Bounds` — the sprite renderer's bounds on the same object (empty without one). ### class NeoColliderBus : NeoBus

Member	Signature
ctor	`(WorldManager? worldManager = null)`
`Collisions`	`List { get; }`
`Colliders`	`List { get; }` — live registered list
`Update()`	`List` — detect pairs, fire callbacks

### class NeoCollision `NeoBoxCollider A`, `NeoBoxCollider B`, `Rectangle Overlap` (public fields). ### interface ICollision `void OnCollision(NeoBoxCollider other, NeoCollision collision)` ## NeoGameLib.NeoInput ### class NeoInputBus : NeoBus `void Update()`; `void Update(KeyboardState current)`; `void Update(KeyboardState current, MouseState mouse)`; `Keys[] ListenInput()`. ### class NeoInputMap

Member	Signature
`AddDigital(string action, params Keys[] keys)`	`void`
`AddMouseButton(string action, params MouseButtons[] buttons)`	`void`
`AddAxis(string action, NeoAxisRange range, Keys? positive = null, Keys? negative = null)`	`void`
`SetAction(string action, params Keys[] keys)`	`void` — throws if unknown
`SetAction(string action, NeoAxisRange range, Keys? positive = null, Keys? negative = null)`	`void` — throws if unknown
`HasAction(string)`	`bool`
`RemoveAction(string)`	`void`
`IsDown(string)` / `IsPressed(string)` / `IsReleased(string)`	`bool` — throws if unknown
`GetAxis(string)`	`float` — throws if unknown
`Subscribe(NeoInputBus? bus = null, bool dedupe = true)`	`void`
`Unsubscribe(NeoInputBus? bus = null, bool dedupe = true)`	`void`

### static class Input `LeftMouseButton` / `MiddleMouseButton` / `RightMouseButton` / `XButton1` / `XButton2` (`NeoMouseAction`), `MousePosition` (`Vector2`, window pixels). ### sealed class NeoMouseAction `bool IsDown()`, `bool IsPressed()`, `bool IsReleased()`. ### enum NeoAxisRange `Positive` (0→1), `Negative` (0→-1), `Full` (-1→1), `PositiveInverted` (1→0), `NegativeInverted` (-1→0), `FullInverted` (1→-1). ### enum MouseButtons `Left`, `Middle`, `Right`, `XButton1`, `XButton2` ## NeoGameLib.NeoUI ### sealed class NeoUIBus : IDisposable `Count`, `Contains(NeoCanvas)`, `void Add(NeoCanvas canvas, bool dedupe = true)`, `void Remove(NeoCanvas canvas, bool dedupe = true)`, `void Clear()`, `void Update(GameTime, Rectangle viewport)`, `void Draw(SpriteBatch)`, `void Dispose()`. ### class NeoUIElement

Member	Signature
`Children`	`NeoUIChildren { get; }`
`Parent`	`NeoUIElement? { get; }`
`Transform`	`ScreenTransform { get; }`
`Enabled` / `Visible`	`bool { get; set; }` = true
`VisualMatrix`	`Matrix { get; }`
`Canvas`	`NeoCanvas? { get; }`
`ScreenToLocal(Vector2)`	`Vector2`
`ContainsScreenPoint(Vector2)`	`bool`
`OnUpdate(GameTime)`	`virtual void`
`OnDraw(SpriteBatch)`	`protected virtual void`
`MeasureContent()`	`protected virtual Vector2`

### sealed class NeoUIChildren : Collection Collection with validation: no canvases as children, no double-parenting, no cycles. Safe to mutate during UI traversal. ### class ScreenTransform : Transform `Size` (0,0), `Anchor` (0.5, 0.5), `Pivot` (0.5, 0.5), `WidthMode` / `HeightMode` (`NeoUISizing`, `Fixed`), `DesiredSize` / `LayoutPosition` / `LayoutSize` (read-only), `HasVisualTransform` (`bool { get; }`). Throws on non-finite sizes and anchors/pivots outside 0..1. ### enum NeoUISizing `Fixed`, `Fill`, `Fit` ### class NeoCanvas : NeoUIElement `Order` (0), `ScaleMode` (`ConstantPixelSize`), `ScaleFactor` (1), `ReferenceResolution` (1280x720), `Match` (0, must be 0..1), `PixelPerfect` (false), `Scale` (`float { get; }`), `ViewportOrigin` (`Vector2 { get; }`), `Bus` (`NeoUIBus? { get; }`), `ScreenToCanvas(Vector2)`, `CanvasToScreen(Vector2)`, `Subscribe(NeoUIBus? bus = null, bool dedupe = true)`, `Unsubscribe(NeoUIBus? bus = null, bool dedupe = true)`. ### enum NeoCanvasScaleMode `ConstantPixelSize`, `ScaleWithScreen` ### class NeoPanel : NeoUIElement `Color` (White), `Padding` (`NeoPadding`). ### class NeoFlexBox : NeoPanel `Direction` (`Row`), `Gap` (0), `Justify` (`Start`), `Align` (`Start`). ### enum NeoFlexDirection `Row`, `Column` ### enum NeoFlexAlign `Start`, `Center`, `End`, `SpaceBetween`, `Stretch` ### class NeoLabel : NeoUIElement `Font` (null), `Text` (""), `Color` (White). Defaults to `Fit` sizing. ### class NeoButton : NeoUIElement `Font`, `Text`, `Color` (White), `HoverColor` (LightGray), `PressedColor` (Gray), `Hovered` (`bool { get; }`), `OnClick` (`Action?`). Defaults to `Fit` sizing. Fires on press+release over the button. ### class NeoImage : NeoUIElement `Texture` (null), `Color` (White), `SourceRectangle` (`Rectangle?`, validated non-negative). ### readonly struct NeoPadding ctors `(all)`, `(horizontal, vertical)`, `(left, top, right, bottom)`; `Left` / `Top` / `Right` / `Bottom` (init-only, non-negative, finite); `TopLeft : Vector2`, `Total : Vector2`; `implicit operator NeoPadding(float)`. ## NeoGameLib.NeoStorage ### class FileStore `FilePath` (`string { get; }`); `virtual Load()`, `Get()` (`string`), `GetAsLines()` (`List`), `Set(string)`, `Set(List)`, `virtual Write()`. ### class JsonStore : FileStore `Options` (`JsonSerializerOptions`, default `IncludeFields = true`); `override Load()`, `override Write()`, `Get(string key)`, `Set(string key, object value)`. ### class FolderStore `FolderPath` (`string { get; }`), `Files` (`List { get; }`), `Load()`, `Instantiate(string fileName) : T where T : FileStore`. ## NeoGameLib.FuckingEvents ### class EventBus `void Subscribe(Action handler)`, `void Publish(T eventData)`. No unsubscribing. Not used by the library; see [Systems](https://docs.ctrl-neo.dev/8.systems#eventbus-avoid). ## Sitemap See the full [sitemap](https://docs.ctrl-neo.dev/sitemap.md) for all pages.