de.ellpeck.rockbottom.api

Interface IGraphics

public interface IGraphics

The graphics context to interact with OpenGL as well as a multitude of game-provided rendering methods. To access these methods, use the IGraphics object given to you in render methods or access IGameInstance.getGraphics()

Method Summary

Modifier and Type	Method and Description
void	backgroundColor(float r, float g, float b, float a) Sets the background color (the color to fill the screen with at the start of every render cycle).
void	backgroundColor(int color) Sets the background color (the color to fill the screen with at the start of every render cycle).
void	bindColor(float r, float g, float b, float a) Binds the specifid color to the GL context.
void	bindColor(int color) Binds the specified color to the GL context.
void	describeItem(IGameInstance game, IAssetManager manager, ItemInstance instance) Renders an item's hover over information on the mouse cursor position.
void	drawHoverInfo(IGameInstance game, IAssetManager manager, float x, float y, float scale, boolean firstLineOffset, boolean canLeaveScreen, int maxLength, java.util.List<java.lang.String> text) Draws a hovering information at the specified position using the specified text
void	drawHoverInfoAtMouse(IGameInstance game, IAssetManager manager, boolean firstLineOffset, int maxLength, java.util.List<java.lang.String> text) Draws a hovering information at the mouse's position using the specified text
void	drawHoverInfoAtMouse(IGameInstance game, IAssetManager manager, boolean firstLineOffset, int maxLength, java.lang.String... text) Draws a hovering information at the mouse's position using the specified text
void	drawRect(float x, float y, float width, float height, float lineWidth, int color) Draws a colored, unfilled rectangle at the specified x and y coordinates.
void	drawRect(float x, float y, float width, float height, int color) Draws a colored, unfilled rectangle at the specified x and y coordinates.
void	fillRect(float x, float y, float width, float height, int color) Draws a colored, filled rectangle at the spcified x and y coordinates.
void	popMatrix() Pops the GL matrix.
void	pushMatrix() Pushes the GL matrix.
void	renderItemInGui(IGameInstance game, IAssetManager manager, ItemInstance slot, float x, float y, float scale, int color) Renders an item and its amount.
void	renderSlotInGui(IGameInstance game, IAssetManager manager, ItemInstance slot, float x, float y, float scale, boolean hovered) Renders a slot.
void	rotate(float angle) Rotates the GL context by the specified angle.
void	scale(float scaleX, float scaleY) Scales the GL context by the specified x and y scale.
void	translate(float x, float y) Translates the GL context by the specified x and y coordinates.

Method Detail

renderSlotInGui

void renderSlotInGui(IGameInstance game,
                     IAssetManager manager,
                     ItemInstance slot,
                     float x,
                     float y,
                     float scale,
                     boolean hovered)

Renders a slot. This displays the (by default) green box based on the gui color as well as the item inside and the amount. To make a slot that has functionality, use ItemContainer to create functioning slots.

Parameters:

game - The game instance

manager - The asset manager

slot - The content of the slot to draw

x - The x coordinate

y - The y coordinate

scale - The scale

hovered - If the slot is currently being hovered or not (ie if it should show the hover info of what is in the slot)

renderItemInGui

void renderItemInGui(IGameInstance game,
                     IAssetManager manager,
                     ItemInstance slot,
                     float x,
                     float y,
                     float scale,
                     int color)

Renders an item and its amount. This is similar to renderSlotInGui(IGameInstance, IAssetManager, ItemInstance, float, float, float, boolean), only that it doesn't render the box below the item.

Parameters:

game - The game instance

manager - The asset manager

slot - The item to draw

x - The x coordinate

y - The y coordinate

scale - The scale

color - The color to filter the item's renderer with

describeItem

void describeItem(IGameInstance game,
                  IAssetManager manager,
                  ItemInstance instance)

Renders an item's hover over information on the mouse cursor position. Additionally, it draws the IGameInstance.isItemInfoDebug() text and also fires the TooltipEvent.

Parameters:

game - The game instance

manager - The asset manager

instance - The item whose information to draw

drawHoverInfoAtMouse

void drawHoverInfoAtMouse(IGameInstance game,
                          IAssetManager manager,
                          boolean firstLineOffset,
                          int maxLength,
                          java.lang.String... text)

Draws a hovering information at the mouse's position using the specified text

Parameters:

game - The game instance

manager - The asset manager

firstLineOffset - If the first line should have a bit of a gap below it making it act as a "headline"

maxLength - The maximum length before the tooltip wraps into the next line

text - The array of lines of text to draw

drawHoverInfoAtMouse

void drawHoverInfoAtMouse(IGameInstance game,
                          IAssetManager manager,
                          boolean firstLineOffset,
                          int maxLength,
                          java.util.List<java.lang.String> text)

Draws a hovering information at the mouse's position using the specified text

Parameters:

game - The game instance

manager - The asset manager

firstLineOffset - If the first line should have a bit of a gap below it making it act as a "headline"

maxLength - The maximum length before the tooltip wraps into the next line

text - The list of lines of text to draw

drawHoverInfo

void drawHoverInfo(IGameInstance game,
                   IAssetManager manager,
                   float x,
                   float y,
                   float scale,
                   boolean firstLineOffset,
                   boolean canLeaveScreen,
                   int maxLength,
                   java.util.List<java.lang.String> text)

Draws a hovering information at the specified position using the specified text

Parameters:

game - The game instance

manager - The asset manager

x - The x position

y - The y position

scale - The scale of the tooltip

firstLineOffset - If the first line should have a bit of a gap below it making it act as a "headline"

canLeaveScreen - If the tooltip can leave the screen or should stop at the borders

maxLength - The maximum length before the tooltip wraps into the next line

text - The list of lines of text to draw

pushMatrix

void pushMatrix()

Pushes the GL matrix. See GL11.glPushMatrix() for reference.

popMatrix

void popMatrix()

Pops the GL matrix. See GL11.glPopMatrix() for reference.

bindColor

void bindColor(int color)

Binds the specified color to the GL context. See GL11.glColor4f(float, float, float, float) for reference. Note that every hex color used in the game needs to contain an alpha component for it to display.

Parameters:

color - The color

bindColor

void bindColor(float r,
               float g,
               float b,
               float a)

Binds the specifid color to the GL context. See GL11.glColor4f(float, float, float, float) for reference.

Parameters:

r - The red component (0-1)

g - The green component (0-1)

b - The blue component (0-1)

a - The alpha (0-1)

backgroundColor

void backgroundColor(int color)

Sets the background color (the color to fill the screen with at the start of every render cycle). See GL11.glClearColor(float, float, float, float) for reference. Note that every hex color used in the game needs to contain an alpha component for it to display.

Parameters:

color - The color

backgroundColor

void backgroundColor(float r,
                     float g,
                     float b,
                     float a)

Sets the background color (the color to fill the screen with at the start of every render cycle). See GL11.glClearColor(float, float, float, float) for reference.

Parameters:

r - The red component (0-1)

g - The green component (0-1)

b - The blue component (0-1)

a - The alpha (0-1)

scale

void scale(float scaleX,
           float scaleY)

Scales the GL context by the specified x and y scale. See GL11.glScalef(float, float, float) for reference.

Parameters:

scaleX - The x scale

scaleY - The y scale

translate

void translate(float x,
               float y)

Translates the GL context by the specified x and y coordinates. See GL11.glPixelTransferf(int, float) for reference.

Parameters:

x - The x coordinate

y - The y coordinate

rotate

void rotate(float angle)

Rotates the GL context by the specified angle. See GL11.glRotatef(float, float, float, float) for reference. Note that this will only ever rotate around one axis as anything else makes little sense in a 2d game.

Parameters:

angle - The angle in degrees to rotate by

drawRect

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

Draws a colored, unfilled rectangle at the specified x and y coordinates.

Parameters:

x - The x coordinate

y - The y coordinate

width - The width

height - The height

color - The color

drawRect

void drawRect(float x,
              float y,
              float width,
              float height,
              float lineWidth,
              int color)

Draws a colored, unfilled rectangle at the specified x and y coordinates.

Parameters:

x - The x coordinate

y - The y coordinate

width - The width

height - The height

lineWidth - The width of the outlines

color - The color

fillRect

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

Draws a colored, filled rectangle at the spcified x and y coordinates.

Parameters:

x - The x coordinate

y - The y coordinate

width - The width

height - The height

color - The color