crystalspace.jbind.impl.video.graph2d
Class csGraphics2D

java.lang.Object
  crystalspace.jbind.impl.csNativeObject
      crystalspace.jbind.impl.csutil.scf.csBase
          crystalspace.jbind.impl.video.graph2d.csGraphics2D

All Implemented Interfaces:

iBase, iGraphics2D, iPointer

public class csGraphics2D

extends csBase

implements iGraphics2D

Author:

qan To change the template for this generated type comment go to Window>Preferences>Java>Code Generation>Code and Comments

Field Summary

Fields inherited from class crystalspace.jbind.impl.csNativeObject

ImplFactory, nPointer

Constructor Summary

csGraphics2D(iPointer nPointer)

Method Summary

void	allowResize(boolean iAllow) Enable/disable canvas resizing.
boolean	beginDraw() This routine should be called before any draw operations.
void	blit(int x, int y, int width, int height, byte[] data) Blit a memory block.
void	clear(int color) Clear backbuffer.
void	clearAll(int color) Clear all video pages.
boolean	clipLine(float x1, float y1, float x2, float y2, int xmin, int ymin, int xmax, int ymax) Clip a line against given rectangle.
void	close() Close the device.
iGraphics2D	createOffscreenCanvas(iPointer memory, int width, int height, int depth, iOffscreenCanvasCallback ofscb) Create an off-screen canvas so you can render on a given memory area.
boolean	doubleBuffer(boolean Enable) Enable or disable double buffering; returns success status.
void	drawBox(int x, int y, int w, int h, int color) Draw a box.
void	drawLine(float x1, float y1, float x2, float y2, int color) Draw a line.
void	drawPixel(int x, int y, int color) Draw a pixel.
void	drawPixels(csPixelCoord pixels, int num_pixels, int color) Draw an array of pixel coordinates with the given color.
int	findRGB(int r, int g, int b) Find an RGB color.
void	finishDraw() This routine should be called when you finished drawing.
void	freeArea(csImageArea Area) Free storage allocated for a subarea of screen.
int[]	getClipRect() Retrieve clipping rectangle.
boolean	getDoubleBufferState() Get the double buffer state.
iFontServer	getFontServer() Get the active font server (does not do IncRef(););.
boolean	getFullScreen() Returns 'true' if the program is being run full-screen.
float	getGamma() Get gamma value.
int	getHeight() Return the height of the framebuffer.
static java.lang.Class	getInterfaceClass()
static java.lang.String	getInterfaceName()
static int	getInterfaceVersion()
java.lang.String	getName() Return the name of the interface
iNativeWindow	getNativeWindow() Get the native window corresponding with this canvas.
int	getPage() Get active videopage number (starting from zero);.
int	getPalEntryCount() Return the number of palette entries that can be modified.
csRGBpixel	getPalette() Get the palette (if there is one);.
byte[]	getPixel(int x, int y) Query pixel R,G,B at given screen location.
iPointer	getPixelAt(int x, int y) Returns the address of the pixel at the specified (x, y); coordinates.
int	getPixelBytes() Return the number of bytes for every pixel.
csPixelFormat	getPixelFormat() Return information about the pixel format.
int	getVersion() Return the version of the interface
int	getWidth() Return the width of the framebuffer.
static void	initSCF()
protected boolean	isNativePointerValidSafe()
boolean	open() Open the device.
void	print(csRect pArea) Flip video pages (or dump backbuffer into framebuffer);.
boolean	resize(int w, int h) Resize the canvas.
void	restoreArea(csImageArea Area, boolean Free) Restore a subarea of screen saved with SaveArea();.
csImageArea	saveArea(int x, int y, int w, int h) Save a subarea of screen and return a handle to saved buffer.
iImage	screenShot() Do a screenshot: return a new iImage object.
void	setClipRect(int nMinX, int nMinY, int nMaxX, int nMaxY) Set clipping rectangle.
void	setFullScreen(boolean b) Change the fullscreen state of the canvas.
boolean	setGamma(float gamma) Set gamma value (if supported by canvas);.
boolean	setMouseCursor(iImage image, csRGBcolor keycolor) Set mouse cursor using an image.
boolean	setMouseCursor(iImage image, csRGBcolor keycolor, int hotspot_x) Set mouse cursor using an image.
boolean	setMouseCursor(iImage image, csRGBcolor keycolor, int hotspot_x, int hotspot_y) Set mouse cursor using an image.
boolean	setMouseCursor(iImage image, csRGBcolor keycolor, int hotspot_x, int hotspot_y, csRGBcolor fg) Set mouse cursor using an image.
boolean	setMouseCursor(iImage image, csRGBcolor keycolor, int hotspot_x, int hotspot_y, csRGBcolor fg, csRGBcolor bg) Set mouse cursor using an image.
boolean	setMouseCursor(int iShape) Set mouse cursor to one of predefined shape classes (see csmcXXX enum above);.
boolean	setMousePosition(int x, int y) Set mouse position (relative to top-left of CS window);.
void	setRGB(int i, int r, int g, int b) Set a color index to given R,G,B (0..255); values.
void	write(iFont font, int x, int y, int fg, int bg, java.lang.String str) Write a text string into the back buffer.
void	write(iFont font, int x, int y, int fg, int bg, java.lang.String str, int flags) Write a text string into the back buffer.
void	writeBaseline(iFont font, int x, int y, int fg, int bg, java.lang.String str) Write a text string into the back buffer.

Methods inherited from class crystalspace.jbind.impl.csutil.scf.csBase

decRef, equals, finalize, getRefCount, incRef, nDelete, queryInterface, queryInterfaceSafe

Methods inherited from class crystalspace.jbind.impl.csNativeObject

changePointer, getPointer, getPointer, getPointerArray, hashCode, isMemoryOwner, isNativePointerValid, isNativePointerValidSafe, newNativeObject, setMemoryOwner, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface crystalspace.jbind.interfaces.iutil.scf.iBase

decRef, getRefCount, incRef, queryInterface, queryInterfaceSafe

Methods inherited from interface crystalspace.jbind.interfaces.iPointer

changePointer, getPointer, isMemoryOwner, setMemoryOwner

Constructor Detail

csGraphics2D

public csGraphics2D(iPointer nPointer)

Parameters:

nPointer -

Method Detail

getVersion

public int getVersion()

Description copied from interface: iBase

Return the version of the interface

Specified by:

getVersion in interface iBase

Specified by:

getVersion in class csBase

getName

public java.lang.String getName()

Description copied from interface: iBase

Return the name of the interface

Specified by:

getName in interface iBase

Specified by:

getName in class csBase

initSCF

public static void initSCF()

getInterfaceVersion

public static int getInterfaceVersion()

getInterfaceName

public static java.lang.String getInterfaceName()

getInterfaceClass

public static java.lang.Class getInterfaceClass()

getWidth

public int getWidth()

Description copied from interface: iGraphics2D

Return the width of the framebuffer. Implemented in csGraphics2D.

Specified by:

getWidth in interface iGraphics2D

Returns:

getHeight

public int getHeight()

Description copied from interface: iGraphics2D

Return the height of the framebuffer. Implemented in csGraphics2D.

Specified by:

getHeight in interface iGraphics2D

Returns:

isNativePointerValidSafe

protected boolean isNativePointerValidSafe()

allowResize

public void allowResize(boolean iAllow)

Description copied from interface: iGraphics2D

Enable/disable canvas resizing. Implemented in csGraphics2D, csGraphics2DOpenGL, csGraphics2DGLX, and csGraphics2DXLib.

Specified by:

allowResize in interface iGraphics2D

Parameters:

iAllow -

See Also:

iGraphics2D.allowResize(boolean)

beginDraw

public boolean beginDraw()

Description copied from interface: iGraphics2D

This routine should be called before any draw operations. It should return true if graphics context is ready. Implemented in csGraphics2DAA, csGraphics2D, csGraphics2DDDraw3, csGraphicsMemory, csGraphics2DNull, csGraphics2DGLCommon, csGraphics2DSDL, and csGraphics2DSVGALib.

Specified by:

beginDraw in interface iGraphics2D

Returns:

See Also:

iGraphics2D.beginDraw()

blit

public void blit(int x,
                 int y,
                 int width,
                 int height,
                 byte[] data)

Description copied from interface: iGraphics2D

Blit a memory block. The format of the image is RGBA in bytes. Row by row. Implemented in csGraphics2D, csGraphics2DNull, and csGraphics2DGLCommon.

Specified by:

blit in interface iGraphics2D

Parameters:

x -

y -

width -

height -

data -

See Also:

iGraphics2D.blit(int, int, int, int, byte[])

clear

public void clear(int color)

Description copied from interface: iGraphics2D

Clear backbuffer. Implemented in csGraphics2D, csGraphics2DNull, and csGraphics2DGLCommon.

Specified by:

clear in interface iGraphics2D

Parameters:

color -

See Also:

iGraphics2D.clear(int)

clearAll

public void clearAll(int color)

Description copied from interface: iGraphics2D

Clear all video pages. Implemented in csGraphics2D, and csGraphics2DNull.

Specified by:

clearAll in interface iGraphics2D

Parameters:

color -

See Also:

iGraphics2D.clearAll(int)

clipLine

public boolean clipLine(float x1,
                        float y1,
                        float x2,
                        float y2,
                        int xmin,
                        int ymin,
                        int xmax,
                        int ymax)

Description copied from interface: iGraphics2D

Clip a line against given rectangle. Function returns true if line is not visible. Implemented in csGraphics2D.

Specified by:

clipLine in interface iGraphics2D

Parameters:

x1 -

y1 -

x2 -

y2 -

xmin -

ymin -

xmax -

ymax -

Returns:

See Also:

iGraphics2D.clipLine(float, float, float, float, int, int, int, int)

close

public void close()

Description copied from interface: iGraphics2D

Close the device. Implemented in csGraphics2DAA, csGraphics2D, csGraphics2DDDraw3, csGraphicsMemory, csGraphics2DNull, csGraphics2DGLCommon, csGraphics2DOpenGL, csGraphics2DGLX, csGraphics2DSDL, csGraphics2DXLib, and csGraphics2DSVGALib.

Specified by:

close in interface iGraphics2D

See Also:

iGraphics2D.close()

createOffscreenCanvas

public iGraphics2D createOffscreenCanvas(iPointer memory,
                                         int width,
                                         int height,
                                         int depth,
                                         iOffscreenCanvasCallback ofscb)

Description copied from interface: iGraphics2D

Create an off-screen canvas so you can render on a given memory area. If depth==8 then the canvas will use palette mode. In that case you can do SetRGB(); to initialize the palette. The callback interface (if given); is used to communicate from the canvas back to the caller. You can use this to detect when the texture data has changed for example. Implemented in csGraphics2D.

Specified by:

createOffscreenCanvas in interface iGraphics2D

Parameters:

memory -

width -

height -

depth -

ofscb -

Returns:

See Also:

iGraphics2D.createOffscreenCanvas(crystalspace.jbind.interfaces.iPointer, int, int, int, crystalspace.jbind.interfaces.ivideo.graph2d.iOffscreenCanvasCallback)

doubleBuffer

public boolean doubleBuffer(boolean Enable)

Description copied from interface: iGraphics2D

Enable or disable double buffering; returns success status. Implemented in csGraphics2D, csGraphics2DDDraw3, csGraphicsMemory, csGraphics2DGLCommon, and csGraphics2DSVGALib.

Specified by:

doubleBuffer in interface iGraphics2D

Parameters:

Enable -

Returns:

See Also:

iGraphics2D.doubleBuffer(boolean)

drawBox

public void drawBox(int x,
                    int y,
                    int w,
                    int h,
                    int color)

Description copied from interface: iGraphics2D

Draw a box. Implemented in csGraphics2D, csGraphics2DNull, and csGraphics2DGLCommon.

Specified by:

drawBox in interface iGraphics2D

Parameters:

x -

y -

w -

h -

color -

See Also:

iGraphics2D.drawBox(int, int, int, int, int)

drawLine

public void drawLine(float x1,
                     float y1,
                     float x2,
                     float y2,
                     int color)

Description copied from interface: iGraphics2D

Draw a line. Implemented in csGraphics2D, csGraphics2DNull, and csGraphics2DGLCommon.

Specified by:

drawLine in interface iGraphics2D

Parameters:

x1 -

y1 -

x2 -

y2 -

color -

See Also:

iGraphics2D.drawLine(float, float, float, float, int)

drawPixel

public void drawPixel(int x,
                      int y,
                      int color)

Description copied from interface: iGraphics2D

Draw a pixel. Implemented in csGraphics2D, csGraphics2DNull, and csGraphics2DGLCommon.

Specified by:

drawPixel in interface iGraphics2D

Parameters:

x -

y -

color -

See Also:

iGraphics2D.drawPixel(int, int, int)

drawPixels

public void drawPixels(csPixelCoord pixels,
                       int num_pixels,
                       int color)

Description copied from interface: iGraphics2D

Draw an array of pixel coordinates with the given color. Implemented in csGraphics2D, csGraphics2DNull, and csGraphics2DGLCommon.

Specified by:

drawPixels in interface iGraphics2D

Parameters:

pixels -

num_pixels -

color -

See Also:

iGraphics2D.drawPixels(crystalspace.jbind.impl.video.graph2d.csPixelCoord, int, int)

findRGB

public int findRGB(int r,
                   int g,
                   int b)

Description copied from interface: iGraphics2D

Find an RGB color. Implemented in csGraphics2D.

Specified by:

findRGB in interface iGraphics2D

Parameters:

r -

g -

b -

Returns:

See Also:

iGraphics2D.findRGB(int, int, int)

finishDraw

public void finishDraw()

Description copied from interface: iGraphics2D

This routine should be called when you finished drawing. Implemented in csGraphics2DAA, csGraphics2D, csGraphics2DDDraw3, csGraphicsMemory, csGraphics2DNull, and csGraphics2DSDL.

Specified by:

finishDraw in interface iGraphics2D

See Also:

iGraphics2D.finishDraw()

freeArea

public void freeArea(csImageArea Area)

Description copied from interface: iGraphics2D

Free storage allocated for a subarea of screen. Implemented in csGraphics2D.

Specified by:

freeArea in interface iGraphics2D

Parameters:

Area -

See Also:

iGraphics2D.freeArea(crystalspace.jbind.impl.video.graph2d.csImageArea)

getClipRect

public int[] getClipRect()

Description copied from interface: iGraphics2D

Retrieve clipping rectangle. Implemented in csGraphics2D.

Specified by:

getClipRect in interface iGraphics2D

Returns:

See Also:

iGraphics2D.getClipRect()

getDoubleBufferState

public boolean getDoubleBufferState()

Description copied from interface: iGraphics2D

Get the double buffer state. Implemented in csGraphics2D, csGraphics2DDDraw3, csGraphics2DGLCommon, and csGraphics2DSVGALib.

Specified by:

getDoubleBufferState in interface iGraphics2D

Returns:

See Also:

iGraphics2D.getDoubleBufferState()

getFontServer

public iFontServer getFontServer()

Description copied from interface: iGraphics2D

Get the active font server (does not do IncRef(););. Implemented in csGraphics2D.

Specified by:

getFontServer in interface iGraphics2D

Returns:

See Also:

iGraphics2D.getFontServer()

getFullScreen

public boolean getFullScreen()

Description copied from interface: iGraphics2D

Returns 'true' if the program is being run full-screen. Implemented in csGraphics2D, csGraphics2DGLX, and csGraphics2DXLib.

Specified by:

getFullScreen in interface iGraphics2D

Returns:

See Also:

iGraphics2D.getFullScreen()

getGamma

public float getGamma()

Description copied from interface: iGraphics2D

Get gamma value. Implemented in csGraphics2D.

Specified by:

getGamma in interface iGraphics2D

Returns:

See Also:

iGraphics2D.getGamma()

getNativeWindow

public iNativeWindow getNativeWindow()

Description copied from interface: iGraphics2D

Get the native window corresponding with this canvas. If this is an off-screen canvas then this will return 0. Implemented in csGraphics2D.

Specified by:

getNativeWindow in interface iGraphics2D

Returns:

See Also:

iGraphics2D.getNativeWindow()

getPage

public int getPage()

Description copied from interface: iGraphics2D

Get active videopage number (starting from zero);. Implemented in csGraphics2D, and csGraphics2DDDraw3.

Specified by:

getPage in interface iGraphics2D

Returns:

See Also:

iGraphics2D.getPage()

getPalEntryCount

public int getPalEntryCount()

Description copied from interface: iGraphics2D

Return the number of palette entries that can be modified. This should return 0 if there is no palette (true color displays);. This function is equivalent to the PalEntries field that you get from GetPixelFormat. It is just a little bit easier to obtain this way. Implemented in csGraphics2D.

Specified by:

getPalEntryCount in interface iGraphics2D

Returns:

See Also:

iGraphics2D.getPalEntryCount()

getPalette

public csRGBpixel getPalette()

Description copied from interface: iGraphics2D

Get the palette (if there is one);. Implemented in csGraphics2D.

Specified by:

getPalette in interface iGraphics2D

Returns:

See Also:

iGraphics2D.getPalette()

getPixel

public byte[] getPixel(int x,
                       int y)

Description copied from interface: iGraphics2D

Query pixel R,G,B at given screen location. Implemented in csGraphics2D.

Specified by:

getPixel in interface iGraphics2D

Parameters:

x -

y -

Returns:

See Also:

iGraphics2D.getPixel(int, int)

getPixelAt

public iPointer getPixelAt(int x,
                           int y)

Description copied from interface: iGraphics2D

Returns the address of the pixel at the specified (x, y); coordinates. Implemented in csGraphics2D, csGraphics2DNull, and csGraphics2DGLCommon.

Specified by:

getPixelAt in interface iGraphics2D

Parameters:

x -

y -

Returns:

See Also:

iGraphics2D.getPixelAt(int, int)

getPixelBytes

public int getPixelBytes()

Description copied from interface: iGraphics2D

Return the number of bytes for every pixel. This function is equivalent to the PixelBytes field that you get from GetPixelFormat. Implemented in csGraphics2D.

Specified by:

getPixelBytes in interface iGraphics2D

Returns:

See Also:

iGraphics2D.getPixelBytes()

getPixelFormat

public csPixelFormat getPixelFormat()

Description copied from interface: iGraphics2D

Return information about the pixel format. Implemented in csGraphics2D.

Specified by:

getPixelFormat in interface iGraphics2D

Returns:

See Also:

iGraphics2D.getPixelFormat()

open

public boolean open()

Description copied from interface: iGraphics2D

Open the device. Implemented in csGraphics2DAA, csGraphics2D, csGraphics2DDDraw3, csGraphicsMemory, csGraphics2DNull, csGraphics2DGLCommon, csGraphics2DOpenGL, csGraphics2DGLX, csGraphics2DSDL, csGraphics2DXLib, and csGraphics2DSVGALib.

Specified by:

open in interface iGraphics2D

Returns:

See Also:

iGraphics2D.open()

print

public void print(csRect pArea)

Description copied from interface: iGraphics2D

Flip video pages (or dump backbuffer into framebuffer);. The area parameter is only a hint to the canvas driver. Changes outside the rectangle may or may not be printed as well. Implemented in csGraphics2DAA, csGraphics2D, csGraphics2DDDraw3, csGraphicsMemory, csGraphics2DNull, csGraphics2DOpenGL, csGraphics2DGLX, csGraphics2DSDL, csGraphics2DXLib, and csGraphics2DSVGALib.

Specified by:

print in interface iGraphics2D

Parameters:

pArea -

See Also:

iGraphics2D.print(crystalspace.jbind.impl.csgeom.csrect.csRect)

resize

public boolean resize(int w,
                      int h)

Description copied from interface: iGraphics2D

Resize the canvas. Implemented in csGraphics2D, csGraphics2DGLCommon, and csGraphics2DXLib.

Specified by:

resize in interface iGraphics2D

Parameters:

w -

h -

Returns:

See Also:

iGraphics2D.resize(int, int)

restoreArea

public void restoreArea(csImageArea Area,
                        boolean Free)

Description copied from interface: iGraphics2D

Restore a subarea of screen saved with SaveArea();. Implemented in csGraphics2D, and csGraphics2DGLCommon.

Specified by:

restoreArea in interface iGraphics2D

Parameters:

Area -

Free -

See Also:

iGraphics2D.restoreArea(crystalspace.jbind.impl.video.graph2d.csImageArea, boolean)

saveArea

public csImageArea saveArea(int x,
                            int y,
                            int w,
                            int h)

Description copied from interface: iGraphics2D

Save a subarea of screen and return a handle to saved buffer. Storage is allocated in this call, you should either FreeArea(); the handle after usage or RestoreArea (); it. Implemented in csGraphics2D, and csGraphics2DGLCommon.

Specified by:

saveArea in interface iGraphics2D

Parameters:

x -

y -

w -

h -

Returns:

See Also:

iGraphics2D.saveArea(int, int, int, int)

screenShot

public iImage screenShot()

Description copied from interface: iGraphics2D

Do a screenshot: return a new iImage object. Implemented in csGraphics2D, and csGraphics2DGLCommon.

Specified by:

screenShot in interface iGraphics2D

Returns:

See Also:

iGraphics2D.screenShot()

setClipRect

public void setClipRect(int nMinX,
                        int nMinY,
                        int nMaxX,
                        int nMaxY)

Description copied from interface: iGraphics2D

Set clipping rectangle. The clipping rectangle is inclusive the top and left edges and exclusive for the right and bottom borders. Implemented in csGraphics2D.

Specified by:

setClipRect in interface iGraphics2D

Parameters:

nMinX -

nMinY -

nMaxX -

nMaxY -

See Also:

iGraphics2D.setClipRect(int, int, int, int)

setFullScreen

public void setFullScreen(boolean b)

Description copied from interface: iGraphics2D

Change the fullscreen state of the canvas. Implemented in csGraphics2D, csGraphics2DGLX, and csGraphics2DXLib.

Specified by:

setFullScreen in interface iGraphics2D

Parameters:

b -

See Also:

iGraphics2D.setFullScreen(boolean)

setGamma

public boolean setGamma(float gamma)

Description copied from interface: iGraphics2D

Set gamma value (if supported by canvas);. By default this is 1. Smaller values are darker. If the canvas doesn't support gamma then this function will return false. Implemented in csGraphics2D.

Specified by:

setGamma in interface iGraphics2D

Parameters:

gamma -

Returns:

See Also:

iGraphics2D.setGamma(float)

setMouseCursor

public boolean setMouseCursor(iImage image,
                              csRGBcolor keycolor,
                              int hotspot_x,
                              int hotspot_y,
                              csRGBcolor fg,
                              csRGBcolor bg)

Description copied from interface: iGraphics2D

Set mouse cursor using an image. If the operation is unsupported, return 'false' otherwise return 'true'. On some platforms there is only monochrome pointers available. In this all black colors in the image will become the value of 'bg' and all non-black colors will become 'fg' Implemented in csGraphics2D, and csGraphics2DXLib.

Specified by:

setMouseCursor in interface iGraphics2D

Parameters:

image -

keycolor -

hotspot_x -

hotspot_y -

fg -

bg -

Returns:

See Also:

iGraphics2D.setMouseCursor(crystalspace.jbind.interfaces.igraphic.image.iImage, crystalspace.jbind.impl.csgfx.rgbpixel.csRGBcolor, int, int, crystalspace.jbind.impl.csgfx.rgbpixel.csRGBcolor, crystalspace.jbind.impl.csgfx.rgbpixel.csRGBcolor)

setMouseCursor

public boolean setMouseCursor(iImage image,
                              csRGBcolor keycolor,
                              int hotspot_x,
                              int hotspot_y,
                              csRGBcolor fg)

Description copied from interface: iGraphics2D

Set mouse cursor using an image. If the operation is unsupported, return 'false' otherwise return 'true'. On some platforms there is only monochrome pointers available. In this all black colors in the image will become the value of 'bg' and all non-black colors will become 'fg' Implemented in csGraphics2D, and csGraphics2DXLib.

Specified by:

setMouseCursor in interface iGraphics2D

Parameters:

image -

keycolor -

hotspot_x -

hotspot_y -

fg -

Returns:

See Also:

iGraphics2D.setMouseCursor(crystalspace.jbind.interfaces.igraphic.image.iImage, crystalspace.jbind.impl.csgfx.rgbpixel.csRGBcolor, int, int, crystalspace.jbind.impl.csgfx.rgbpixel.csRGBcolor)

setMouseCursor

public boolean setMouseCursor(iImage image,
                              csRGBcolor keycolor,
                              int hotspot_x,
                              int hotspot_y)

Description copied from interface: iGraphics2D

Set mouse cursor using an image. If the operation is unsupported, return 'false' otherwise return 'true'. On some platforms there is only monochrome pointers available. In this all black colors in the image will become the value of 'bg' and all non-black colors will become 'fg' Implemented in csGraphics2D, and csGraphics2DXLib.

Specified by:

setMouseCursor in interface iGraphics2D

Parameters:

image -

keycolor -

hotspot_x -

hotspot_y -

Returns:

See Also:

iGraphics2D.setMouseCursor(crystalspace.jbind.interfaces.igraphic.image.iImage, crystalspace.jbind.impl.csgfx.rgbpixel.csRGBcolor, int, int)

setMouseCursor

public boolean setMouseCursor(iImage image,
                              csRGBcolor keycolor,
                              int hotspot_x)

Description copied from interface: iGraphics2D

Set mouse cursor using an image. If the operation is unsupported, return 'false' otherwise return 'true'. On some platforms there is only monochrome pointers available. In this all black colors in the image will become the value of 'bg' and all non-black colors will become 'fg' Implemented in csGraphics2D, and csGraphics2DXLib.

Specified by:

setMouseCursor in interface iGraphics2D

Parameters:

image -

keycolor -

hotspot_x -

Returns:

See Also:

iGraphics2D.setMouseCursor(crystalspace.jbind.interfaces.igraphic.image.iImage, crystalspace.jbind.impl.csgfx.rgbpixel.csRGBcolor, int)

setMouseCursor

public boolean setMouseCursor(iImage image,
                              csRGBcolor keycolor)

Description copied from interface: iGraphics2D

Set mouse cursor using an image. If the operation is unsupported, return 'false' otherwise return 'true'. On some platforms there is only monochrome pointers available. In this all black colors in the image will become the value of 'bg' and all non-black colors will become 'fg' Implemented in csGraphics2D, and csGraphics2DXLib.

Specified by:

setMouseCursor in interface iGraphics2D

Parameters:

image -

keycolor -

Returns:

See Also:

iGraphics2D.setMouseCursor(crystalspace.jbind.interfaces.igraphic.image.iImage, crystalspace.jbind.impl.csgfx.rgbpixel.csRGBcolor)

setMouseCursor

public boolean setMouseCursor(int iShape)

Description copied from interface: iGraphics2D

Set mouse cursor to one of predefined shape classes (see csmcXXX enum above);. If a specific mouse cursor shape is not supported, return 'false'; otherwise return 'true'. If system supports it the cursor should be set to its nearest system equivalent depending on iShape argument and the routine should return "true". Implemented in csGraphics2DAA, csGraphics2D, csGraphics2DDDraw3, csGraphics2DNull, csGraphics2DOpenGL, csGraphics2DGLX, csGraphics2DSDL, and csGraphics2DXLib.

Specified by:

setMouseCursor in interface iGraphics2D

Parameters:

iShape -

Returns:

See Also:

iGraphics2D.setMouseCursor(int)

setMousePosition

public boolean setMousePosition(int x,
                                int y)

Description copied from interface: iGraphics2D

Set mouse position (relative to top-left of CS window);. Implemented in csGraphics2DAA, csGraphics2D, csGraphics2DDDraw3, csGraphics2DNull, csGraphics2DOpenGL, csGraphics2DGLX, csGraphics2DSDL, and csGraphics2DXLib.

Specified by:

setMousePosition in interface iGraphics2D

Parameters:

x -

y -

Returns:

See Also:

iGraphics2D.setMousePosition(int, int)

setRGB

public void setRGB(int i,
                   int r,
                   int g,
                   int b)

Description copied from interface: iGraphics2D

Set a color index to given R,G,B (0..255); values. Implemented in csGraphics2DAA, csGraphics2D, csGraphics2DDDraw3, csGraphics2DNull, csGraphics2DGLCommon, csGraphics2DOpenGL, csGraphics2DSDL, csGraphics2DXLib, and csGraphics2DSVGALib.

Specified by:

setRGB in interface iGraphics2D

Parameters:

i -

r -

g -

b -

See Also:

iGraphics2D.setRGB(int, int, int, int)

write

public void write(iFont font,
                  int x,
                  int y,
                  int fg,
                  int bg,
                  java.lang.String str,
                  int flags)

Description copied from interface: iGraphics2D

Write a text string into the back buffer. A negative value for bg color will not draw the background. Implemented in csGraphics2D.

Specified by:

write in interface iGraphics2D

Parameters:

font -

x -

y -

fg -

bg -

str -

flags -

See Also:

iGraphics2D.write(crystalspace.jbind.interfaces.ivideo.fontserv.iFont, int, int, int, int, java.lang.String, int)

write

public void write(iFont font,
                  int x,
                  int y,
                  int fg,
                  int bg,
                  java.lang.String str)

Description copied from interface: iGraphics2D

Write a text string into the back buffer. A negative value for bg color will not draw the background. Implemented in csGraphics2D.

Specified by:

write in interface iGraphics2D

Parameters:

font -

x -

y -

fg -

bg -

str -

See Also:

iGraphics2D.write(crystalspace.jbind.interfaces.ivideo.fontserv.iFont, int, int, int, int, java.lang.String)

writeBaseline

public void writeBaseline(iFont font,
                          int x,
                          int y,
                          int fg,
                          int bg,
                          java.lang.String str)

Description copied from interface: iGraphics2D

Write a text string into the back buffer. A negative value for bg color will not draw the background. x and y are the pen position on a baseline. The actual font baseline is shifted up by the font's descent.

Specified by:

writeBaseline in interface iGraphics2D

Parameters:

font -

x -

y -

fg -

bg -

str -

See Also:

iGraphics2D.writeBaseline(crystalspace.jbind.interfaces.ivideo.fontserv.iFont, int, int, int, int, java.lang.String)