BansheeEngine/Documentation/Manuals/Native/manuals.md

Manuals {#manuals}

[TOC]

Here you will find a list of all manuals relating to Banshee's native code, primarily focusing on explaining the engine internals instead of the user-facing code. The manuals are roughly ordered in the way they should be read, although if you are interested in a specific topic feel free to skip ahead as manuals often contain cross references to prerequisite manuals.

Name	Description
Getting started	Shows how to perform some basic operations using Banshee's user-facing interface. Allows you to get a general idea of how Banshee works.
Architecture	Gives you an overview of the entire architecture of Banshee. Useful starting point for those modifying engine internals as it provides a way to identify major systems.
Utilities	Provides an overview of a variety of utility systems used throughout Banshee.
Core thread	Explains how core (rendering) thread works, how it interacts with simulation thread, what are core objects and how to create your own.
Resources	Explains how resources work, including saving, loading and creating brand new resource types.
RTTI	Shows you how to add run-time type information for your objects.
Game objects	Explains what are scene objects and components and how can you use them to create your scene.
Render API	Explains how to use the render API to use the graphics pipeline and draw objects.
Textures	Shows you how to create, use and manipulate textures.
Meshes	Shows you how to create, use and manipulate meshes.
Render targets	Shows you how to create and use render textures and windows.
GPU programs	Shows you how to create and use GPU programs.
Materials	Shows you how to create and use materials and shaders.
Scripting	Shows you how to interact with the scripting system, and how to expose C++ objects to the scripting API.
Renderer	Explains how the renderer works on the low level, and how to create a custom renderer so you may fully customize the look of your application.
BSLFX	Provides a reference for the Banshee Shading Language FX syntax.
Custom GUI elements	Shows you how to create custom GUI elements, manually render text or modify GUI system in a general way.
Custom importers	Shows you how to create importers that handle conversion of third party resources into engine ready formats.
Custom plugins	Shows you how to create custom plugins that can be loaded by Banshee.
Quick reference	Provides a few bits of commonly required information, that might be hard to remember otherwise.
Porting	Information about how to go on about porting Banshee to a different operating system.
Code style	Information about code style used when writing Banshee.