Imaginary Game Engine API documentation
GraphicsDriver Class
NamespacesIGEGraphicsDriver

[This is preliminary documentation and is subject to change.]

GraphicsDriver class, handles all rendering
Declaration Syntax
C#Visual BasicVisual C++
public abstract class GraphicsDriver : RenderWindow, IDisposable
Public MustInherit Class GraphicsDriver _
	Inherits RenderWindow _
	Implements IDisposable
public ref class GraphicsDriver abstract : public RenderWindow, 
	IDisposable
Members
All MembersConstructorsMethodsPropertiesFieldsEvents



IconMemberDescription
GraphicsDriver(Engine, Int32, Size, Boolean, String)
Constructor for new window

GraphicsDriver(Engine, Int32, WindowEnvironment, Object)
Constructor for existing window

ActiveCamera
Get the current active camera

Closing
Event signalling that the window is closing
(Inherited from RenderWindow.)
ConvertColor(Color)
Convert a Color to a driver color

ConvertColor(Int32)
Convert a driver color to a Color

CreateTexture(PixelFormat, Size, Boolean)
Create a new empty texture

DevCaps
Get this devices capabilities

Dispose()()()
Dispose this object

EndFrame()()()
End the current frame

Engine
Get the Engine we're running on

Environment
Get the current environment
(Inherited from RenderWindow.)
Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
ExecuteCommand(GraphicsDriver..::.GraphicsCommand)
Execute a command on the underlying API

Finalize()()()
Destructor
(Overrides Object.Finalize()()().)
FSAA
Number of Anti-Aliasing buffers

GetHashCode()()()
Serves as a hash function for a particular type. GetHashCode()()() is suitable for use in hashing algorithms and data structures like a hash table.
(Inherited from Object.)
GetMaterial(String, array<Object>[]()[])
Get a material for this driver by name

GetShaderMaterial(String, array<Object>[]()[])
Get a Basic Material with request shaderset for this driver from the library

GetShaderSet(String, array<Object>[]()[])
Get a shaderset for this driver from the library

GetTexture(array<Byte>[]()[]%, Texture, Int32, GraphicsDriver..::.GetTextureCallback)
Get a texture from the video memory

GetTexture(array<Byte>[]()[]%, Texture, Int32)
Get a texture from the video memory (Pauses current thread until texture is fetched)

GetType()()()
Gets the Type of the current instance.
(Inherited from Object.)
GetVar(String)
Get a stored custom setting (usefull for extensions)

GuiOverlay
Get or Set the frontal, fullscreen GUI plane

guiplane
Frontal, fullscreen GUI plane

Handle
Get the handle to the current window (RenderWindow..::.X11Handle on X11, IntPtr on Windows)
(Inherited from RenderWindow.)
InitialiseAPI()()()
Initialise the underlying API (ie. OpenGL)

KeyPress
Event signalling that a keyboard key has been pressed
(Inherited from RenderWindow.)
KeyRelease
Event signalling that a keyboard key has been released
(Inherited from RenderWindow.)
LoadMaterial(Material)
Load an object

LoadMeshBuffer(IRenderable, MeshUpdateFrequency)
Buffer a mesh

LoadRenderBuffer(RenderBuffer)
Load a renderbuffer into the driver

LoadShader(ShaderSet)
Load a set of shaders on the driver

LoadTexture<(Of <(T>)>)(String, Boolean)
Load a texture from a file or cache

LoadTexture<(Of <(T>)>)(String)
Load a texture from file or cache

LoadTexture(ImageFile, Boolean)
Load a texture from file without cache

LoadTexture(String, Boolean)
Load a texture from a file or cache, guessing the image type using Engine

LoadTexture(String)
Load a texture from file or cache

MaxShaderTextures
Get the maximum number of textures to be used in a shader

MaxTextureCoords
Get the maximum number of textures coordinates to be used in a shader

MaxTextures
Get the maximum number of textures to be used in the FFP

MemberwiseClone()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
MouseButtonPress
Event signalling that a mouse button has been pressed
(Inherited from RenderWindow.)
MouseButtonRelease
Event signalling that a mouse button has been released
(Inherited from RenderWindow.)
MouseMove
Event signalling that the mouse cursor has moved
(Inherited from RenderWindow.)
mouseposition
Current cursor position on the window
(Inherited from RenderWindow.)
mousesens
Mouse sensitivity
(Inherited from RenderWindow.)
MouseSensitivity
Get or Set mouse sensitivity
(Inherited from RenderWindow.)
MouseWheel
Event signalling that the scrollwheel has been turned
(Inherited from RenderWindow.)
OnKeyPress(Keys)
Fire KeyPress event
(Inherited from RenderWindow.)
OnKeyRelease(Keys)
Fire KeyRelease event
(Inherited from RenderWindow.)
OnMouseDown(MouseButton, Point)
Fire MouseButtonPress event
(Inherited from RenderWindow.)
OnMouseMove(Point, PointF)
Fire MouseMove event
(Inherited from RenderWindow.)
OnMouseUp(MouseButton, Point)
Fire MouseButtonRelease event
(Inherited from RenderWindow.)
OnMouseWheel(Int32)
Fire MouseWheel event
(Inherited from RenderWindow.)
OnWindowClose()()()
Fire Closing event
(Inherited from RenderWindow.)
OnWindowResize()()()
Fire Resizing
(Inherited from RenderWindow.)
pActiveCamera
Current active camera

pEngine
The engine we're running on

pEnvironment
Current environment
(Inherited from RenderWindow.)
pHandle
Handle to the window, X11Handle on X11 and IntPtr on Windows
(Inherited from RenderWindow.)
PlayVideo(IVideo)
Start playing a video

pMaxShaderTextures
Max number of textures in a shader

pMaxTextureCoords
Max number of texture coords in a shader

pMaxTextures
Max number of textures in ffp

primitivecount
Amount of faces rendered

publicDevCaps
Public device capabilities flags

RegisterWindow()()()
Get window properties and register ourself to receive input messages
(Inherited from RenderWindow.)
RenderImage(Material, Size, SizeF)
Render a texture as 2D image (for image-space conversions etc.)

RenderObjects(Scene)
Render all objects in scene

renderThread
Thread used for rendering

Resizing
Event signalling that the window is being resized
(Inherited from RenderWindow.)
ScreenShot(GraphicsDriver..::.SaveScreenShot)
Make a screenshot of the current scene

SendCommand(GraphicsDriver..::.CommandType, Object)
Send a command to the Graphics Thread

SetRenderTarget(RenderBuffer)
Set the current target to render to

Size
Get the window size (px)
(Inherited from RenderWindow.)
ToString()()()
Returns a String that represents the current Object.
(Inherited from Object.)
UnloadMaterial(Material)
Unload a material

UnloadMeshBuffer(MeshBuffer)
Delete a buffered mesh

UnloadRenderBuffer(RenderBuffer)
Unload a renderbuffer from the driver

UnloadShader(ShaderSet)
Unload a set of shaders from the driver

UnloadTexture(Object)
Unload a texture from the driver

UpdateTexture(Texture, ImageFile, Rectangle)
Update texture data

WindowCocoa(Size, Boolean, String)
Create a Cocoa window
(Inherited from RenderWindow.)
WindowGdi(Size, Boolean, String)
Create a GDI (Windows' System.Windows.Forms) window
(Inherited from RenderWindow.)
windowsize
Window size (px)
(Inherited from RenderWindow.)
WindowX(Size, Boolean, String)
Create a X11 window
(Inherited from RenderWindow.)
Inheritance Hierarchy
Object
RenderWindow
 GraphicsDriver

Assembly: IGE Core (Module: IGE Core) Version: 0.1.2957.39562 (0.1.0.0)