org.mini2Dx.core

Interface Graphics

All Known Implementing Classes:

LibgdxGraphics

public interface Graphics

Common interface to graphics rendering functionality

Method Summary

Modifier and Type	Method and Description
void	clearBlendFunction() Resets the blend function to its default
void	clearContext() Clears the graphics context (e.g.
void	clearContext(Color color) Clears the graphics context (e.g.
void	clearContext(Color color, boolean depthBufferBit, boolean colorBufferBit) Clears the graphics context (e.g.
void	clearScaling() Resets scaling back to default values
void	clearShader() Clears the Shader program applied to this instance
void	disableBlending() Disables blending during rendering
void	drawCircle(float centerX, float centerY, float radius) Draws a circle to the window in the current Color with the set line height
void	drawCircle(float centerX, float centerY, int radius) Draws a circle to the window in the current Color with the set line height
void	drawFontCache(GameFontCache gameFontCache) Draws a GameFontCache to the screen
void	drawLineSegment(float x1, float y1, float x2, float y2) Renders a line segment to the window in the current Color with the set line height
void	drawNinePatch(NinePatch ninePatch, float x, float y, float width, float height) Draws a NinePatch to screen
void	drawParticleEffect(ParticleEffect effect) Draws a ParticleEffect to screen
void	drawPolygon(float[] vertices) Draws a polygon to the window in the current Color
void	drawRect(float x, float y, float width, float height) Renders a rectangle to the window in the current Color with the set line height
void	drawShape(Shape shape) Draws an instance of Shape
void	drawSprite(Sprite sprite) Draws a Sprite with all transformations applied to this graphics context
void	drawSprite(Sprite sprite, float x, float y) Draws a Sprite at the given coordinates with all transformations applied to this graphics context
void	drawSpriteCache(SpriteCache spriteCache, int cacheId) Draws a SpriteCache
void	drawString(java.lang.String text, float x, float y) Draws a string to the window
void	drawString(java.lang.String text, float x, float y, float targetWidth) Draws a string to the window, automatically wrapping it within a specified width
void	drawString(java.lang.String text, float x, float y, float targetWidth, int horizontalAlign) Draws a string to the window, automatically wrapping it within a specified width and aligning it to the left, center or right of the width
void	drawTexture(Texture texture, float x, float y) Draws a texture to this graphics context
void	drawTexture(Texture texture, float x, float y, boolean flipY) Draws a texture to this graphics context
void	drawTexture(Texture texture, float x, float y, float width, float height) Draws a texture to this graphics context
void	drawTexture(Texture texture, float x, float y, float width, float height, boolean flipY)
void	drawTextureRegion(TextureRegion textureRegion, float x, float y) Draws a texture region to this graphics context
void	drawTextureRegion(TextureRegion textureRegion, float x, float y, float width, float height) Draws a texture region to this graphics context
void	drawTextureRegion(TextureRegion textureRegion, float x, float y, float width, float height, float rotation) Draws a texture region to this graphics context
void	drawTilingDrawable(TilingDrawable tilingDrawable, float x, float y, float width, float height) Draws a TilingDrawable to screen
void	drawTriangle(float x1, float y1, float x2, float y2, float x3, float y3) Draws a triangle to the window in the current Color
void	enableBlending() Enables blending during rendering
void	fillCircle(float centerX, float centerY, float radius) Fills a circle to the window in the current Color
void	fillCircle(float centerX, float centerY, int radius) Fills a circle to the window in the current Color
void	fillPolygon(float[] vertices, short[] triangles) Fills a polygon to the window in the current Color
void	fillRect(float x, float y, float width, float height) Fills a rectangle to the window in the current Color
void	fillShape(Shape shape) Fills an instance of Shape
void	fillTriangle(float x1, float y1, float x2, float y2, float x3, float y3) Draws a triangle to the window in the current Color
void	flush() Immediately flushes everything rendered rather than waiting until the end of rendering
Color	getBackgroundColor() Returns the background Color
Color	getColor() Returns the Color to draw shapes with
GameFont	getFont() Returns the GameFont to draw Strings with
long	getFrameId() Returns the frame number
int	getLineHeight() Returns the line height used
TextureFilter	getMagFilter() Returns the current mag texture filter.
TextureFilter	getMinFilter() Returns the current min texture filter.
org.mini2Dx.gdx.math.Matrix4	getProjectionMatrix() Returns the Matrix4 viewport projection
float	getRotation() Returns the viewport rotation (in degrees)
float	getRotationX() Returns the origin X coordinate of the viewport rotation
float	getRotationY() Returns the origin Y coordinate of the viewport rotation
float	getScaleX() Returns the X scaling factor
float	getScaleY() Returns the Y scaling factor
Shader	getShader() Returns the currently applied Shader program
Color	getTint() Returns the Color tint being applied to all draw operations
float	getTranslationX() Returns the translation of the viewport along the X axis
float	getTranslationY() Returns the translation of the viewport along the Y axis
float	getViewportHeight() Returns the height of the viewport
float	getViewportWidth() Returns the width of the viewport
int	getWindowHeight() Returns the height of the window
int	getWindowSafeHeight() Returns the safe height of the window.
int	getWindowSafeWidth() Returns the safe width of the window.
int	getWindowSafeX() Returns the X coordinate of the beginning of the safe area.
int	getWindowSafeY() Returns the Y coordinate of the beginning of the safe area.
int	getWindowWidth() Returns the width of the window
boolean	isWindowReady() Returns if the game window is initialised natively
Rectangle	peekClip() Returns the current clip
void	peekClip(Rectangle rectangle) Returns the current clip
void	postRender() Called by mini2Dx after rendering
void	preRender(int gameWidth, int gameHeight) Called by mini2Dx before rendering begins
Rectangle	removeClip() Removes the applied clip
void	removeTint() Removes the tinting Color
void	rotate(float degrees, float x, float y) Rotates the canvas by the provided degrees around the provided point
void	scale(float scaleX, float scaleY) Scales the canvas (multiplies scale value)
void	setBackgroundColor(Color backgroundColor) Sets the background Color to be used
void	setBlendFunction(Mini2DxBlendFunction srcFunc, Mini2DxBlendFunction dstFunc) Sets the blend function to be applied OpenGL Blend Function Cheatsheet
void	setClip(float x, float y, float width, float height) Sets the graphics context clip.
void	setClip(Rectangle clip) Sets the graphics context clip.
void	setColor(Color color) Sets the Color to draw shapes with
void	setFont(GameFont font) Sets the GameFont to draw Strings with
void	setLineHeight(int lineHeight) Sets the line height to be used
void	setMagFilter(TextureFilter filter) Sets the texture mag filter that will be used for all the subsequent texture drawing operations
void	setMinFilter(TextureFilter filter) Sets the texture min filter that will be used for all the subsequent texture drawing operations
void	setRotation(float degrees, float x, float y) Sets the canvas rotation around a provided point
void	setScale(float scaleX, float scaleY) Sets the canvas scale
void	setShader(Shader shader) Applies a Shader program to this instance
void	setTint(Color tint) Sets the Color to apply to draw operations
void	setTranslation(float translateX, float translateY) Sets the translation coordinates
void	translate(float translateX, float translateY) Moves the graphics context by a certain amount of the X and Y axis

Method Detail

preRender

void preRender(int gameWidth,
               int gameHeight)

Called by mini2Dx before rendering begins

Parameters:

gameWidth - The current game window width

gameHeight - The current game window height

postRender

void postRender()

Called by mini2Dx after rendering

clearContext

void clearContext()

Clears the graphics context (e.g. glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT) on OpenGL platforms) using the background color

clearContext

void clearContext(Color color)

Clears the graphics context (e.g. glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT) on OpenGL platforms)

Parameters:

color - The Color to clear with

clearContext

void clearContext(Color color,
                  boolean depthBufferBit,
                  boolean colorBufferBit)

Clears the graphics context (e.g. glClear on OpenGL platforms)

Parameters:

color - The Color to clear with

depthBufferBit - True if depth buffer bit should be set during clear

colorBufferBit - True if color buffer bit should be set during clear

drawLineSegment

void drawLineSegment(float x1,
                     float y1,
                     float x2,
                     float y2)

Renders a line segment to the window in the current Color with the set line height

Parameters:

x1 - X coordinate of point A

y1 - Y coordinate of point A

x2 - X coordinate of point B

y2 - Y coordinate of point B

drawRect

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

Renders a rectangle to the window in the current Color with the set line height

Parameters:

x - The x coordinate to render at

y - The y coordinate to render at

width - The width of the rectangle

height - The height of the rectangle

fillRect

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

Fills a rectangle to the window in the current Color

Parameters:

x - The x coordinate to render at

y - The y coordinate to render at

width - The width of the rectangle

height - The height of the rectangle

drawCircle

void drawCircle(float centerX,
                float centerY,
                int radius)

Draws a circle to the window in the current Color with the set line height

Parameters:

centerX - The x coordinate of the center of the circle

centerY - The y coordinate of the center of the circle

radius - The radius of the circle

drawCircle

void drawCircle(float centerX,
                float centerY,
                float radius)

Draws a circle to the window in the current Color with the set line height

Parameters:

centerX - The x coordinate of the center of the circle

centerY - The y coordinate of the center of the circle

radius - The radius of the circle

fillCircle

void fillCircle(float centerX,
                float centerY,
                int radius)

Fills a circle to the window in the current Color

Parameters:

centerX - The x coordinate of the center of the circle

centerY - The y coordinate of the center of the circle

radius - The radius of the circle

fillCircle

void fillCircle(float centerX,
                float centerY,
                float radius)

Fills a circle to the window in the current Color

Parameters:

centerX - The x coordinate of the center of the circle

centerY - The y coordinate of the center of the circle

radius - The radius of the circle

drawTriangle

void drawTriangle(float x1,
                  float y1,
                  float x2,
                  float y2,
                  float x3,
                  float y3)

Draws a triangle to the window in the current Color

Parameters:

x1 - The x coordinate of the first point

y1 - The y coordinate of the first point

x2 - The x coordinate of the second point

y2 - The y coordinate of the second point

x3 - The x coordinate of the third point

y3 - The y coordinate of the third point

fillTriangle

void fillTriangle(float x1,
                  float y1,
                  float x2,
                  float y2,
                  float x3,
                  float y3)

Draws a triangle to the window in the current Color

Parameters:

x1 - The x coordinate of the first point

y1 - The y coordinate of the first point

x2 - The x coordinate of the second point

y2 - The y coordinate of the second point

x3 - The x coordinate of the third point

y3 - The y coordinate of the third point

drawPolygon

void drawPolygon(float[] vertices)

Draws a polygon to the window in the current Color

Parameters:

vertices - The vertices of the polygon in format x1,y1,x2,y2,x3,y3,etc.

fillPolygon

void fillPolygon(float[] vertices,
                 short[] triangles)

Fills a polygon to the window in the current Color

Parameters:

vertices - The vertices of the polygon in format x1,y1,x2,y2,x3,y3,etc.

triangles - The indices in the vertices parameter that make up the triangles of the polygon

drawString

void drawString(java.lang.String text,
                float x,
                float y)

Draws a string to the window

Parameters:

text - The String to draw

x - The x coordinate to draw at

y - The y coordinate to draw at

drawString

void drawString(java.lang.String text,
                float x,
                float y,
                float targetWidth)

Draws a string to the window, automatically wrapping it within a specified width

Parameters:

text - The String to draw

x - The x coordinate to draw at

y - The y coordinate to draw at

targetWidth - The width to render the String at. Note: The string will automatically wrapped if it is longer.

drawString

void drawString(java.lang.String text,
                float x,
                float y,
                float targetWidth,
                int horizontalAlign)

Draws a string to the window, automatically wrapping it within a specified width and aligning it to the left, center or right of the width

Parameters:

text - The String to draw

x - The x coordinate to draw at

y - The y coordinate to draw at

targetWidth - The width to render the String at. Note: The string will automatically wrapped if it is longer.

horizontalAlign - The horizontal alignment

drawTexture

void drawTexture(Texture texture,
                 float x,
                 float y)

Draws a texture to this graphics context

Parameters:

texture - The Texture to draw

x - The x coordinate to draw at

y - The y coordinate to draw at

drawTexture

void drawTexture(Texture texture,
                 float x,
                 float y,
                 boolean flipY)

Draws a texture to this graphics context

Parameters:

texture - The Texture to draw

x - The x coordinate to draw at

y - The y coordinate to draw at

flipY - True if the texture should be flipped vertically

drawTexture

void drawTexture(Texture texture,
                 float x,
                 float y,
                 float width,
                 float height)

Draws a texture to this graphics context

Parameters:

texture - The Texture to draw

x - The x coordinate to draw at

y - The y coordinate to draw at

width - The width to draw the texture (this can stretch/shrink the texture if not matching the texture's width)

height - The height to draw the texture (this can stretch/shrink the texture if not matching the texture's height)

drawTexture

void drawTexture(Texture texture,
                 float x,
                 float y,
                 float width,
                 float height,
                 boolean flipY)

Parameters:

texture - The Texture to draw

x - The x coordinate to draw at

y - The y coordinate to draw at

width - The width to draw the texture (this can stretch/shrink the texture if not matching the texture's width)

height - The height to draw the texture (this can stretch/shrink the texture if not matching the texture's height)

flipY - True if the texture should be flipped vertically

drawTextureRegion

void drawTextureRegion(TextureRegion textureRegion,
                       float x,
                       float y)

Draws a texture region to this graphics context

Parameters:

textureRegion - The TextureRegion to draw

x - The x coordinate to draw at

y - The y coordinate to draw at

drawTextureRegion

void drawTextureRegion(TextureRegion textureRegion,
                       float x,
                       float y,
                       float width,
                       float height)

Draws a texture region to this graphics context

Parameters:

textureRegion - The TextureRegion to draw

x - The x coordinate to draw at

y - The y coordinate to draw at

width - The width to draw the region (this can stretch/shrink the texture if not matching the region's width)

height - The height to draw the region (this can stretch/shrink the texture if not matching the region's height)

drawTextureRegion

void drawTextureRegion(TextureRegion textureRegion,
                       float x,
                       float y,
                       float width,
                       float height,
                       float rotation)

Draws a texture region to this graphics context

Parameters:

textureRegion - The TextureRegion to draw

x - The x coordinate to draw at

y - The y coordinate to draw at

width - The width to draw the region (this can stretch/shrink the texture if not matching the region's width)

height - The height to draw the region (this can stretch/shrink the texture if not matching the region's height)

rotation - The rotation in degrees (rotated around the top-left corner of the region)

drawShape

void drawShape(Shape shape)

Draws an instance of Shape

Parameters:

shape - The implementation of Shape to draw

fillShape

void fillShape(Shape shape)

Fills an instance of Shape

Parameters:

shape - The implementation of Shape to fill

drawSprite

void drawSprite(Sprite sprite)

Draws a Sprite with all transformations applied to this graphics context

Parameters:

sprite - The Sprite to draw

drawSprite

void drawSprite(Sprite sprite,
                float x,
                float y)

Draws a Sprite at the given coordinates with all transformations applied to this graphics context

Parameters:

sprite - The Sprite to draw

x - The x coordinate to render at

y - The y coordinate to render at

drawSpriteCache

void drawSpriteCache(SpriteCache spriteCache,
                     int cacheId)

Draws a SpriteCache

Parameters:

spriteCache - The SpriteCache to draw

cacheId - The cacheId to draw

drawParticleEffect

void drawParticleEffect(ParticleEffect effect)

Draws a ParticleEffect to screen

Parameters:

effect - The effect to be drawn

drawNinePatch

void drawNinePatch(NinePatch ninePatch,
                   float x,
                   float y,
                   float width,
                   float height)

Draws a NinePatch to screen

Parameters:

ninePatch - The NinePatch to be drawn

x - The x coordinate to draw at

y - The y coordiante to draw at

width - The width to apply to the NinePatch

height - The height to apply to the NinePatch

drawTilingDrawable

void drawTilingDrawable(TilingDrawable tilingDrawable,
                        float x,
                        float y,
                        float width,
                        float height)

Draws a TilingDrawable to screen

Parameters:

tilingDrawable - The TilingDrawable to be drawn

x - The x coordinate to draw at

y - The y coordinate to draw at

width - The width to render

height - The height to render

drawFontCache

void drawFontCache(GameFontCache gameFontCache)

Draws a GameFontCache to the screen

Parameters:

gameFontCache - The GameFontCache to render

setClip

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

Sets the graphics context clip. Only pixels within this area will be rendered

Parameters:

x - The x coordinate the clip begins at

y - The y coordinate the clip begins at

width - The width of the clip

height - The height of the clip

setClip

void setClip(Rectangle clip)

Sets the graphics context clip. Only pixels within this area will be rendered

Parameters:

clip - The clip area

removeClip

Rectangle removeClip()

Removes the applied clip

Returns:

Null if there is no clip

peekClip

Rectangle peekClip()

Returns the current clip

Returns:

A new Rectangle set to the clip coordinates. See peekClip(Rectangle)

peekClip

void peekClip(Rectangle rectangle)

Returns the current clip

Parameters:

rectangle - Applies the current clip coordinates to this Rectangle. If there is no clip it is set to the viewport dimensions.

setTint

void setTint(Color tint)

Sets the Color to apply to draw operations

Parameters:

tint - The Color to tint with

setFont

void setFont(GameFont font)

Sets the GameFont to draw Strings with

Parameters:

font - A non-null instance of GameFont

removeTint

void removeTint()

Removes the tinting Color

enableBlending

void enableBlending()

Enables blending during rendering

disableBlending

void disableBlending()

Disables blending during rendering

setShader

void setShader(Shader shader)

Applies a Shader program to this instance

Parameters:

shader - The Shader to apply

getShader

Shader getShader()

Returns the currently applied Shader program

Returns:

clearShader

void clearShader()

Clears the Shader program applied to this instance

setBlendFunction

void setBlendFunction(Mini2DxBlendFunction srcFunc,
                      Mini2DxBlendFunction dstFunc)

Sets the blend function to be applied OpenGL Blend Function Cheatsheet

Parameters:

srcFunc - Source GL function

dstFunc - Destination GL function

clearBlendFunction

void clearBlendFunction()

Resets the blend function to its default

flush

void flush()

Immediately flushes everything rendered rather than waiting until the end of rendering

getLineHeight

int getLineHeight()

Returns the line height used

Returns:

A value greater than 0

setLineHeight

void setLineHeight(int lineHeight)

Sets the line height to be used

Parameters:

lineHeight - A value greater than 0

getColor

Color getColor()

Returns the Color to draw shapes with

Returns:

A non-null value

setColor

void setColor(Color color)

Sets the Color to draw shapes with

Parameters:

color -

getBackgroundColor

Color getBackgroundColor()

Returns the background Color

Returns:

A non-null value

setBackgroundColor

void setBackgroundColor(Color backgroundColor)

Sets the background Color to be used

getFont

GameFont getFont()

Returns the GameFont to draw Strings with

Returns:

15pt Arial font by default unless setFont() is called

getTint

Color getTint()

Returns the Color tint being applied to all draw operations

Returns:

getScaleX

float getScaleX()

Returns the X scaling factor

Returns:

getScaleY

float getScaleY()

Returns the Y scaling factor

Returns:

scale

void scale(float scaleX,
           float scaleY)

Scales the canvas (multiplies scale value)

Parameters:

scaleX - Scaling along the X axis

scaleY - Scaling along the Y axis

setScale

void setScale(float scaleX,
              float scaleY)

Sets the canvas scale

Parameters:

scaleX - Scaling along the X axis

scaleY - Scaling along the Y axis

clearScaling

void clearScaling()

Resets scaling back to default values

getTranslationX

float getTranslationX()

Returns the translation of the viewport along the X axis

Returns:

getTranslationY

float getTranslationY()

Returns the translation of the viewport along the Y axis

Returns:

translate

void translate(float translateX,
               float translateY)

Moves the graphics context by a certain amount of the X and Y axis

Parameters:

translateX - The x axis translation

translateY - The y axis translation

setTranslation

void setTranslation(float translateX,
                    float translateY)

Sets the translation coordinates

Parameters:

translateX - The x axis translation

translateY - The y axis translation

getRotation

float getRotation()

Returns the viewport rotation (in degrees)

Returns:

Defaults to 0f

getRotationX

float getRotationX()

Returns the origin X coordinate of the viewport rotation

Returns:

Defaults to 0f

getRotationY

float getRotationY()

Returns the origin Y coordinate of the viewport rotation

Returns:

Defaults to 0f

rotate

void rotate(float degrees,
            float x,
            float y)

Rotates the canvas by the provided degrees around the provided point

Parameters:

degrees - The degree value in a clockwise direction

x - The x coordinate to rotate around

y - The y coordinate to rotate around

setRotation

void setRotation(float degrees,
                 float x,
                 float y)

Sets the canvas rotation around a provided point

Parameters:

degrees - The degree value in a clockwise direction

x - The x coordinate to rotate around

y - The y coordinate to rotate around

getProjectionMatrix

org.mini2Dx.gdx.math.Matrix4 getProjectionMatrix()

Returns the Matrix4 viewport projection

Returns:

isWindowReady

boolean isWindowReady()

Returns if the game window is initialised natively

Returns:

False at startup, true once the window/game is visible to the user

getWindowWidth

int getWindowWidth()

Returns the width of the window

Returns:

getWindowHeight

int getWindowHeight()

Returns the height of the window

Returns:

getWindowSafeX

int getWindowSafeX()

Returns the X coordinate of the beginning of the safe area. This only applies to consoles running on television. See more info here.

Returns:

getWindowSafeY

int getWindowSafeY()

Returns the Y coordinate of the beginning of the safe area. This only applies to consoles running on television. See more info here.

Returns:

getWindowSafeWidth

int getWindowSafeWidth()

Returns the safe width of the window. This only applies to consoles running on television. See more info here.

Returns:

getWindowSafeHeight

int getWindowSafeHeight()

Returns the safe height of the window. This only applies to consoles running on television. See more info here.

Returns:

getViewportWidth

float getViewportWidth()

Returns the width of the viewport

Returns:

getViewportHeight

float getViewportHeight()

Returns the height of the viewport

Returns:

getFrameId

long getFrameId()

Returns the frame number

Returns:

getMinFilter

TextureFilter getMinFilter()

Returns the current min texture filter.

Returns:

The current min texture filter.

setMinFilter

void setMinFilter(TextureFilter filter)

Sets the texture min filter that will be used for all the subsequent texture drawing operations

Parameters:

filter - The min filter to be set.

getMagFilter

TextureFilter getMagFilter()

Returns the current mag texture filter.

Returns:

The current mag texture filter.

setMagFilter

void setMagFilter(TextureFilter filter)

Sets the texture mag filter that will be used for all the subsequent texture drawing operations

Parameters:

filter - The mag filter to be set.