Public Member Functions
void	SetDefaultViewportOrthographicSize (float value)
	Set the default ortographic size to be used for all viewport (if not explicitly passed by SetViewport(int, int, int, int, float, bool) method. More...

void	SetViewport (int x, int y, int width, int height, float orthoSize=0, bool virtualScreen=false)
	Set the current viewport for this window More...

void	SetZNearZFar (float near, float far)

void	EnableDepthTest ()

void	DisableDepthTest ()

void	CullFrontFaces ()

void	CullBackFaces ()

void	DisableCullFaces ()

void	SetCurrent ()

void	SetLogger (ILogger logger)

void	Log (string message)

void	SetCamera (Camera camera)

PostProcessingEffect	AddPostProcessingEffect (PostProcessingEffect effect)

void	ClearPostProcessingEffects ()

PostProcessingEffect	SetPostProcessingEffect (int index, PostProcessingEffect effect)

void	SetClearColor (float r, float g, float b, float a=1)

void	SetClearColor (int r, int g, int b, int a=255)

void	SetClearColor (Vector4 color)

void	ClearColor ()

void	SetScissorTest (bool enabled)

void	SetScissorTest (int x, int y, int width, int height)

void	SetScissorTest (float x, float y, float width, float height)

void	BindTextureToUnit (Texture texture, int unit)

void	ResetFrameBuffer ()

void	RenderTo (RenderTexture renderTexture, bool clear=true, float orthoSize=0)

void	SetAlphaBlending ()

void	SetMaskedBlending ()

	Window (string title, int depthSize=16, int antialiasingSamples=0, int stencilSize=0)
	Create a window using primary device width and height. More...

	Window (int width, int height, string title, bool fullScreen=false, int depthSize=16, int antialiasingSamples=0, int stencilSize=0)
	Create a window with a specific width and height More...

bool	SetResolution (int screenWidth, int screenHeight)
	Set resolution for this window. More...

bool	SetResolution (Vector2 newResolution)
	Set resolution for this window. More...

void	SetVSync (bool enable)
	Enable or Disable Vertical Sync More...

void	SetIcon (string path)
	Sets Window's Icon More...

void	SetFullScreen (bool enable)
	Change Full screen mode for this window More...

void	SetSize (int width, int height)
	Change size for the this window More...

void	SetMouseVisible (bool enable)
	Sets mouse cursor visibility More...

void	SetTitle (string text)
	Set the title for the window More...

void	Update ()
	Present the rendered scene to the user, update events and delta time since last update. More...

void	Close ()
	Close the window More...

void	Exit (int code=0)
	Close the window and kill the application More...

bool	GetKey (KeyCode key)
	Returns true when `key` is pressed More...

Vector2	JoystickAxisLeftRaw (int index)

Vector2	JoystickAxisRightRaw (int index)

Vector2	JoystickAxisLeft (int index, float threshold=0.1f)

Vector2	JoystickAxisRight (int index, float threshold=0.1f)

float	JoystickTriggerLeftRaw (int index)

float	JoystickTriggerRightRaw (int index)

float	JoystickTriggerLeft (int index, float threshold=0.1f)

float	JoystickTriggerRight (int index, float threshold=0.1f)

bool	JoystickShoulderLeft (int index)

bool	JoystickShoulderRight (int index)

bool	JoystickLeftStick (int index)

bool	JoystickRightStick (int index)

bool	JoystickUp (int index)

bool	JoystickDown (int index)

bool	JoystickRight (int index)

bool	JoystickLeft (int index)

void	JoystickVibrate (int index, float left, float right)

bool	JoystickA (int index)

bool	JoystickB (int index)

bool	JoystickX (int index)

bool	JoystickBack (int index)

bool	JoystickStart (int index)

bool	JoystickBigButton (int index)

bool	JoystickY (int index)

string	JoystickDebug (int index)

Static Public Member Functions
static void	SetCurrent (Window targetWindow)

static void	SetObsoleteMode ()

Public Attributes
List< int >	textureGC = new List<int>()

List< int >	bufferGC = new List<int>()

List< int >	vaoGC = new List<int>()

List< int >	shaderGC = new List<int>()

Protected Attributes
float	zNear

float	zFar

Properties
Vector2	CurrentViewportPosition `[get, set]`
	Return the position of the last activated viewport by SetViewport(int, int, int, int, float, bool) method. More...

Vector2	CurrentViewportSize `[get, set]`
	Return the size of the last activated viewport by SetViewport(int, int, int, int, float, bool) method. More...

float	CurrentViewportOrthographicSize `[get]`
	Return the orthographic size of the last activated viewport by SetViewport(int, int, int, int, float, bool) method. More...

int	Width `[get]`
	Return the width of this `Window` More...

int	Height `[get]`
	Return the height of this `Window` More...

float	CurrentViewportAspectRatio `[get]`
	Return the aspect ratio (width / height) of the last activated viewport by SetViewport(int, int, int, int, float, bool) method. More...

int	ScaledWidth `[get]`

int	ScaledHeight `[get]`

float	OrthoWidth `[get]`

float	OrthoHeight `[get]`

string	Version `[get]`

string	Vendor `[get]`

string	SLVersion `[get]`

string	Renderer `[get]`

string	Extensions `[get]`

float	ZNear `[get]`

float	ZFar `[get]`

static Window	Current `[get]`

bool	IsOpened `[get, set]`
	Check if the window is opened More...

float	DeltaTime `[get]`
	Time (in seconds) passed since the last Update() More...

Camera	CurrentCamera `[get]`

Matrix4	ProjectionMatrix `[get, set]`

static bool	IsObsolete `[get]`

PostProcessingEffect[]	PostProcessingEffects `[get]`

int	ActivePostProcessingEffectsCount `[get]`

static string[]	Displays `[get]`
	Return the available displays for this computer. More...

static Vector2[]	Resolutions `[get]`
	Return the available resolutions for this computer. More...

static string[]	Joysticks `[get]`
	Return the available joysticks for this computer. More...

GameWindow	Context `[get, set]`

Vector2	Position `[get, set]`
	Get / Set window position More...

bool	HasFocus `[get]`
	Check if this window has focus. More...

float	MouseX `[get]`
	Returns mouse X position relative to the window More...

float	MouseY `[get]`
	Returns mouse Y position relative to the window More...

Vector2	MousePosition `[get]`
	Returns mouse position relative to the window as a vector2 More...

float	RawMouseX `[get]`

float	RawMouseY `[get]`

Vector2	RawMousePosition `[get]`

bool	MouseLeft `[get]`
	Returns `true` if mouse left button is pressed, otherwise `false` More...

bool	MouseRight `[get]`
	Returns `true` if mouse right button is pressed, otherwise `false` More...

bool	MouseMiddle `[get]`
	Returns `true` if mouse middle button is pressed, otherwise `false` More...

float	MouseWheel `[get]`
	Returns mouse wheel position More...

bool	MouseButton1 `[get]`

bool	MouseButton2 `[get]`

bool	MouseButton3 `[get]`

bool	MouseButton4 `[get]`

bool	MouseButton5 `[get]`

bool	MouseButton6 `[get]`

bool	MouseButton7 `[get]`

bool	MouseButton8 `[get]`

bool	MouseButton9 `[get]`

Constructor & Destructor Documentation

Aiv.Fast2D.Window.Window	(	string	title,
		int	depthSize = `16`,
		int	antialiasingSamples = `0`,
		int	stencilSize = `0`
	)

inline

Create a window using primary device width and height.

Parameters

title	the title for this window
depthSize	number of bit for the depth buffer (e.g. 16bit, 32bit, 64bit). Default is 16
antialiasingSamples	number of samples for antialiasing. Default is 0
stencilSize	number of bit for the stencil buffer. Default is 0

Aiv.Fast2D.Window.Window	(	int	width,
		int	height,
		string	title,
		bool	fullScreen = `false`,
		int	depthSize = `16`,
		int	antialiasingSamples = `0`,
		int	stencilSize = `0`
	)

inline

Create a window with a specific width and height

Parameters

width	the width of the window
height	the height of the window
title	the title for this window
fullScreen	if window has to be in full screen mode. Default is false.
depthSize	number of bit for the depth buffer (e.g. 16bit, 32bit, 64bit). Default is 16
antialiasingSamples	number of samples for antialiasing. Default is 0
stencilSize	number of bit for the stencil buffer. Default is 0

Member Function Documentation

PostProcessingEffect Aiv.Fast2D.Window.AddPostProcessingEffect ( PostProcessingEffect effect )

inline

void Aiv.Fast2D.Window.BindTextureToUnit	(	Texture	texture,
		int	unit
	)

inline

void Aiv.Fast2D.Window.ClearColor ( )

inline

void Aiv.Fast2D.Window.ClearPostProcessingEffects ( )

inline

void Aiv.Fast2D.Window.Close ( )

inline

Close the window

void Aiv.Fast2D.Window.CullBackFaces ( )

inline

void Aiv.Fast2D.Window.CullFrontFaces ( )

inline

void Aiv.Fast2D.Window.DisableCullFaces ( )

inline

void Aiv.Fast2D.Window.DisableDepthTest ( )

inline

void Aiv.Fast2D.Window.EnableDepthTest ( )

inline

void Aiv.Fast2D.Window.Exit ( int code = 0 )

inline

Close the window and kill the application

Parameters

code	the exit code. Default is 0.

bool Aiv.Fast2D.Window.GetKey ( KeyCode key )

inline

Returns true when key is pressed

Parameters

key	key to check if a KeyCode is pressed

bool Aiv.Fast2D.Window.JoystickA ( int index )

inline

Vector2 Aiv.Fast2D.Window.JoystickAxisLeft	(	int	index,
		float	threshold = `0.1f`
	)

inline

Vector2 Aiv.Fast2D.Window.JoystickAxisLeftRaw ( int index )

inline

Vector2 Aiv.Fast2D.Window.JoystickAxisRight	(	int	index,
		float	threshold = `0.1f`
	)

inline

Vector2 Aiv.Fast2D.Window.JoystickAxisRightRaw ( int index )

inline

bool Aiv.Fast2D.Window.JoystickB ( int index )

inline

bool Aiv.Fast2D.Window.JoystickBack ( int index )

inline

bool Aiv.Fast2D.Window.JoystickBigButton ( int index )

inline

string Aiv.Fast2D.Window.JoystickDebug ( int index )

inline

bool Aiv.Fast2D.Window.JoystickDown ( int index )

inline

bool Aiv.Fast2D.Window.JoystickLeft ( int index )

inline

bool Aiv.Fast2D.Window.JoystickLeftStick ( int index )

inline

bool Aiv.Fast2D.Window.JoystickRight ( int index )

inline

bool Aiv.Fast2D.Window.JoystickRightStick ( int index )

inline

bool Aiv.Fast2D.Window.JoystickShoulderLeft ( int index )

inline

bool Aiv.Fast2D.Window.JoystickShoulderRight ( int index )

inline

bool Aiv.Fast2D.Window.JoystickStart ( int index )

inline

float Aiv.Fast2D.Window.JoystickTriggerLeft	(	int	index,
		float	threshold = `0.1f`
	)

inline

float Aiv.Fast2D.Window.JoystickTriggerLeftRaw ( int index )

inline

float Aiv.Fast2D.Window.JoystickTriggerRight	(	int	index,
		float	threshold = `0.1f`
	)

inline

float Aiv.Fast2D.Window.JoystickTriggerRightRaw ( int index )

inline

bool Aiv.Fast2D.Window.JoystickUp ( int index )

inline

void Aiv.Fast2D.Window.JoystickVibrate	(	int	index,
		float	left,
		float	right
	)

inline

bool Aiv.Fast2D.Window.JoystickX ( int index )

inline

bool Aiv.Fast2D.Window.JoystickY ( int index )

inline

void Aiv.Fast2D.Window.Log ( string message )

inline

void Aiv.Fast2D.Window.RenderTo	(	RenderTexture	renderTexture,
		bool	clear = `true`,
		float	orthoSize = `0`
	)

inline

void Aiv.Fast2D.Window.ResetFrameBuffer ( )

inline

void Aiv.Fast2D.Window.SetAlphaBlending ( )

inline

void Aiv.Fast2D.Window.SetCamera ( Camera camera )

inline

void Aiv.Fast2D.Window.SetClearColor	(	float	r,
		float	g,
		float	b,
		float	a = `1`
	)

inline

void Aiv.Fast2D.Window.SetClearColor	(	int	r,
		int	g,
		int	b,
		int	a = `255`
	)

inline

void Aiv.Fast2D.Window.SetClearColor ( Vector4 color )

inline

static void Aiv.Fast2D.Window.SetCurrent ( Window targetWindow )

inlinestatic

void Aiv.Fast2D.Window.SetCurrent ( )

inline

void Aiv.Fast2D.Window.SetDefaultViewportOrthographicSize ( float value )

inline

Set the default ortographic size to be used for all viewport (if not explicitly passed by SetViewport(int, int, int, int, float, bool) method.

Parameters

value

void Aiv.Fast2D.Window.SetFullScreen ( bool enable )

inline

Change Full screen mode for this window

Parameters

enabled true for full screen, false otherwise

void Aiv.Fast2D.Window.SetIcon ( string path )

inline

Sets Window's Icon

Parameters

path	path to the icon. Should be an .ico file. Path could be either a filesystem path or a resource path

void Aiv.Fast2D.Window.SetLogger ( ILogger logger )

inline

void Aiv.Fast2D.Window.SetMaskedBlending ( )

inline

void Aiv.Fast2D.Window.SetMouseVisible ( bool enable )

inline

Sets mouse cursor visibility

Parameters

enabled true to show mouse, false otherwise

static void Aiv.Fast2D.Window.SetObsoleteMode ( )

inlinestatic

PostProcessingEffect Aiv.Fast2D.Window.SetPostProcessingEffect	(	int	index,
		PostProcessingEffect	effect
	)

inline

bool Aiv.Fast2D.Window.SetResolution	(	int	screenWidth,
		int	screenHeight
	)

inline

Set resolution for this window.

Parameters

screenWidth
screenHeight

Returns

bool Aiv.Fast2D.Window.SetResolution ( Vector2 newResolution )

inline

Set resolution for this window.

Parameters

newResolution a vector2 representing x = width and y = height

Returns

void Aiv.Fast2D.Window.SetScissorTest ( bool enabled )

inline

void Aiv.Fast2D.Window.SetScissorTest	(	int	x,
		int	y,
		int	width,
		int	height
	)

inline

void Aiv.Fast2D.Window.SetScissorTest	(	float	x,
		float	y,
		float	width,
		float	height
	)

inline

void Aiv.Fast2D.Window.SetSize	(	int	width,
		int	height
	)

inline

Change size for the this window

Parameters

width	the new width of the window
height	the new height of the window

void Aiv.Fast2D.Window.SetTitle ( string text )

inline

Set the title for the window

void Aiv.Fast2D.Window.SetViewport	(	int	x,
		int	y,
		int	width,
		int	height,
		float	orthoSize = `0`,
		bool	virtualScreen = `false`
	)

inline

Set the current viewport for this window

Parameters

x	x position of top-left corner where the viewport start
y	y position of top-left corner where the viewport start
width	the width of the viewport
height	the height of the viewport
orthoSize	the ortographic size of the viewport (default = 0)
virtualScreen	if this viewport is a virtual screen (default = false)

void Aiv.Fast2D.Window.SetVSync ( bool enable )

inline

Enable or Disable Vertical Sync

Parameters

enabled true to enable VSync, false otherwise

void Aiv.Fast2D.Window.SetZNearZFar	(	float	near,
		float	far
	)

inline

void Aiv.Fast2D.Window.Update ( )

inline

Present the rendered scene to the user, update events and delta time since last update.

Member Data Documentation

List<int> Aiv.Fast2D.Window.bufferGC = new List<int>()

List<int> Aiv.Fast2D.Window.shaderGC = new List<int>()

List<int> Aiv.Fast2D.Window.textureGC = new List<int>()

List<int> Aiv.Fast2D.Window.vaoGC = new List<int>()

float Aiv.Fast2D.Window.zFar

protected

float Aiv.Fast2D.Window.zNear

protected

Property Documentation

int Aiv.Fast2D.Window.ActivePostProcessingEffectsCount

get

GameWindow Aiv.Fast2D.Window.Context

getset

Window Aiv.Fast2D.Window.Current

staticget

Camera Aiv.Fast2D.Window.CurrentCamera

get

float Aiv.Fast2D.Window.CurrentViewportAspectRatio

get

Return the aspect ratio (width / height) of the last activated viewport by SetViewport(int, int, int, int, float, bool) method.

float Aiv.Fast2D.Window.CurrentViewportOrthographicSize

get

Return the orthographic size of the last activated viewport by SetViewport(int, int, int, int, float, bool) method.

Vector2 Aiv.Fast2D.Window.CurrentViewportPosition

getset

Return the position of the last activated viewport by SetViewport(int, int, int, int, float, bool) method.

Vector2 Aiv.Fast2D.Window.CurrentViewportSize

getset

Return the size of the last activated viewport by SetViewport(int, int, int, int, float, bool) method.

float Aiv.Fast2D.Window.DeltaTime

get

Time (in seconds) passed since the last Update()

string [] Aiv.Fast2D.Window.Displays

staticget

Return the available displays for this computer.

string Aiv.Fast2D.Window.Extensions

get

bool Aiv.Fast2D.Window.HasFocus

get

Check if this window has focus.

int Aiv.Fast2D.Window.Height

get

Return the height of this Window

bool Aiv.Fast2D.Window.IsObsolete

staticget

bool Aiv.Fast2D.Window.IsOpened

getset

Check if the window is opened

string [] Aiv.Fast2D.Window.Joysticks

staticget

Return the available joysticks for this computer.

bool Aiv.Fast2D.Window.MouseButton1

get

bool Aiv.Fast2D.Window.MouseButton2

get

bool Aiv.Fast2D.Window.MouseButton3

get

bool Aiv.Fast2D.Window.MouseButton4

get

bool Aiv.Fast2D.Window.MouseButton5

get

bool Aiv.Fast2D.Window.MouseButton6

get

bool Aiv.Fast2D.Window.MouseButton7

get

bool Aiv.Fast2D.Window.MouseButton8

get

bool Aiv.Fast2D.Window.MouseButton9

get

bool Aiv.Fast2D.Window.MouseLeft

get

Returns true if mouse left button is pressed, otherwise false

bool Aiv.Fast2D.Window.MouseMiddle

get

Returns true if mouse middle button is pressed, otherwise false

Vector2 Aiv.Fast2D.Window.MousePosition

get

Returns mouse position relative to the window as a vector2

bool Aiv.Fast2D.Window.MouseRight

get

Returns true if mouse right button is pressed, otherwise false

float Aiv.Fast2D.Window.MouseWheel

get

Returns mouse wheel position

float Aiv.Fast2D.Window.MouseX

get

Returns mouse X position relative to the window

float Aiv.Fast2D.Window.MouseY

get

Returns mouse Y position relative to the window

float Aiv.Fast2D.Window.OrthoHeight

get

float Aiv.Fast2D.Window.OrthoWidth

get

Vector2 Aiv.Fast2D.Window.Position

getset

Get / Set window position

PostProcessingEffect [] Aiv.Fast2D.Window.PostProcessingEffects

get

Matrix4 Aiv.Fast2D.Window.ProjectionMatrix

getset

Vector2 Aiv.Fast2D.Window.RawMousePosition

get

float Aiv.Fast2D.Window.RawMouseX

get

float Aiv.Fast2D.Window.RawMouseY

get

string Aiv.Fast2D.Window.Renderer

get

Vector2 [] Aiv.Fast2D.Window.Resolutions

staticget

Return the available resolutions for this computer.

int Aiv.Fast2D.Window.ScaledHeight

get

int Aiv.Fast2D.Window.ScaledWidth

get

string Aiv.Fast2D.Window.SLVersion

get

string Aiv.Fast2D.Window.Vendor

get

string Aiv.Fast2D.Window.Version

get

int Aiv.Fast2D.Window.Width

get

Return the width of this Window

float Aiv.Fast2D.Window.ZFar

get

float Aiv.Fast2D.Window.ZNear

get

The documentation for this class was generated from the following files:

aiv-fast2d/Window.cs
aiv-fast2d/Window_Desktop.cs

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Properties

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation