Tilengine.java

/*
JTilengine - Java binding for 2D Graphics library with raster effects
Copyright (c) 2015-2018 Marc Palacios Domenech (megamarc@hotmail.com)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/

// ****************************************************************************
// Tilengine Class wrapper - Up to date to library version 1.11
// http://www.tilengine.org
// ****************************************************************************

public class Tilengine
{
	static{
		System.loadLibrary ("TilengineJNI");
	}
	
	// CreateWindow flags 
	public static final int CWF_FULLSCREEN	= (1 << 0);
	public static final int CWF_VSYNC		= (1 << 1);
	public static final int CWF_S1			= (1 << 2);
	public static final int CWF_S2			= (2 << 2);
	public static final int CWF_S3			= (3 << 2);
	public static final int CWF_S4			= (4 << 2);
	public static final int CWF_S5			= (5 << 2);		
	public static final int CWF_NEAREST		= (6 << 2);
	
	// error codes 
	public static final int TLN_ERR_OK				= 0;	// No error 
	public static final int TLN_ERR_OUT_OF_MEMORY	= 1;	// Not enough memory 
	public static final int TLN_ERR_IDX_LAYER		= 2;	// Layer index out of range 
	public static final int TLN_ERR_IDX_SPRITE		= 3;	// Sprite index out of range 
	public static final int TLN_ERR_IDX_ANIMATION	= 4;	// Animation index out of range 
	public static final int TLN_ERR_IDX_PICTURE		= 5;	// Picture or tile index out of range 
	public static final int TLN_ERR_REF_TILESET		= 6;	// Invalid TLN_Tileset reference 
	public static final int TLN_ERR_REF_TILEMAP		= 7;	// Invalid TLN_Tilemap reference 
	public static final int TLN_ERR_REF_SPRITESET	= 8;	// Invalid TLN_Spriteset reference 
	public static final int TLN_ERR_REF_PALETTE		= 9;	// Invalid TLN_Palette reference 
	public static final int TLN_ERR_REF_SEQUENCE	= 10;	// Invalid TLN_SequencePack reference 
	public static final int TLN_ERR_REF_SEQPACK		= 11;	// Invalid TLN_Sequence reference 
	public static final int TLN_ERR_REF_BITMAP		= 12;	// Invalid TLN_Bitmap reference 
	public static final int TLN_ERR_NULL_POINTER	= 13;	// Null pointer as argument  
	public static final int TLN_ERR_FILE_NOT_FOUND	= 14;	// Resource file not found 
	public static final int TLN_ERR_WRONG_FORMAT	= 15;	// Resource file has invalid format 
	public static final int TLN_ERR_WRONG_SIZE		= 16;	// A width or height parameter is invalid 
	public static final int TLN_ERR_UNSUPPORTED		= 17;	// Unsupported function
	public static final int TLN_ERR_REF_LIST		= 18;	// Invalid TLN_ObjectList reference
	
	// SetLayerBlendMode & SetSpriteBlendMode modes 
	public static final int BLEND_NONE	= 0;
	public static final int BLEND_MIX	= 1;
	public static final int BLEND_ADD	= 2;
	public static final int BLEND_SUB	= 3;
	public static final int BLEND_MOD	= 4;
	
	// Player
	public static final int PLAYER1 = 0;
	public static final int PLAYER2 = 1;
	public static final int PLAYER3 = 2;
	public static final int PLAYER4 = 3;	
	
	// GetInput 
	public static final int INPUT_NONE		= 0;
	public static final int INPUT_UP		= 1;
	public static final int INPUT_DOWN		= 2;
	public static final int INPUT_LEFT		= 3;
	public static final int INPUT_RIGHT		= 4;
	public static final int INPUT_BUTTON1	= 5;
	public static final int INPUT_BUTTON2	= 6;
	public static final int INPUT_BUTTON3	= 7;
	public static final int INPUT_BUTTON4	= 8;
	public static final int INPUT_BUTTON5	= 9;
	public static final int INPUT_BUTTON6	= 10;
	public static final int INPUT_START 	= 11;
	public static final int INPUT_QUIT 		= 12;
	public static final int INPUT_CRT 		= 13;
	
	// player request modifier flag
	public static final int INPUT_P1 = (PLAYER1 << 5);
	public static final int INPUT_P2 = (PLAYER2 << 5);
	public static final int INPUT_P3 = (PLAYER3 << 5);
	public static final int INPUT_P4 = (PLAYER4 << 5);
	
	// compatibility symbols for pre-1.18 input model
	public static final int INPUT_A = INPUT_BUTTON1;
	public static final int INPUT_B = INPUT_BUTTON2;
	public static final int INPUT_C = INPUT_BUTTON3;
	public static final int INPUT_D = INPUT_BUTTON4;
	public static final int INPUT_E = INPUT_BUTTON5;
	public static final int INPUT_F = INPUT_BUTTON6;

	// overlays for CRT effect

	public static final int TLN_OVERLAY_NONE        	= 0; /*!< no overlay */
	public static final int TLN_OVERLAY_SHADOWMASK      = 1; /*!< Shadow mask pattern */
	public static final int TLN_OVERLAY_APERTURE        = 2; /*!< Aperture grille pattern */
	public static final int TLN_OVERLAY_SCANLINES       = 3; /*!< Scanlines pattern */
	public static final int TLN_OVERLAY_CUSTOM          = 4; /*!< User-provided when calling TLN_CreateWindow() */
	public static final int TLN_MAX_OVERLAY             = 5;
	
	// affine transform 
	final class Affine{
		float angle;	// rotation 
		float dx,dy;	// translation 
		float sx,sy;	// scale 
	}

	// tile 
	final class Tile{
		short index;		// tile index 
		short flags;		// attributes 
	}
	
	// color strip 
	final class ColorStrip{
		int   delay;		// time delay between frames 
		short first;		// index of first color to cycle 
		short count;		// number of colors in the cycle 
		byte  dir;			// direction: 0=descending, 1=ascending 
	}
	
	// sequence info returned by GetSequenceInfo()
	final class SequenceInfo{
		String name;	// sequence name
		int num_frames;	// number of frames
	}
	
	// Sprite creation info for CreateSpriteset()
	final class SpriteData{
		String name;	// entry name
		int x;			// horizontal position
		int y;			// vertical position
		int w;			// width
		int h;			// height
	}

	final class SpriteInfo{
		int offset;
		int w,h;
	}

	// Tile information returned by GetLayerTile()
	final class TileInfo{
		short index;
		short flags;
		int row;
		int col;
		int xoffset;
		int yoffset;
		byte color;
		byte type;
		boolean empty;
	}
	
	// Object item info returned by GetObjectInfo()
	final class ObjectInfo{
		short id;			// unique ID
		short gid;			// graphic ID (tile index)
		short flags;		// attributes (FLAG_FLIPX, FLAG_FLIPY, FLAG_PRIORITY)
		int x;				// horizontal position
		int y;				// vertical position
		int width;			// horizontal size
		int height;			// vertical size
		byte type;			// type property
		boolean visible;	// visible property
		String name;		// name property
	}
	
	// basic management 
	public native int Init (int hres, int vres, int numlayers, int numsprites, int numanimations);
	public native void Deinit ();
	public native int GetNumObjects ();
	public native int GetUsedMemory ();
	public native int GetVersion ();
	public native int GetNumLayers ();
	public native int GetNumSprites ();
	public native void SetBGColor (int r, int g, int b);
	public native boolean SetBGBitmap (int bitmap);
	public native boolean SetBGPalette (int palette);
	public native void SetRasterCallback (Object obj, String methodname);
	public native void SetRenderTarget (int[] data, int pitch);
	public native void UpdateFrame (int frame);
	public native void SetLoadPath (String path);
	public native void SetWindowTitle (String title);
	
	// error handling 
	public native void SetLastError (int error);
	public native int GetLastError ();
	public native String GetErrorString (int error);

	// window management 
	public native boolean CreateWindow (String overlay, int flags);
	public native boolean CreateWindowThread (String overlay, int flags);
	public native boolean ProcessWindow ();
	public native boolean IsWindowActive ();
	public native boolean GetInput (int id);
	public native void DrawFrame (int frame);
	public native void WaitRedraw ();
	public native void DeleteWindow ();
	public native void EnableBlur (boolean mode);
	public native int GetTicks ();
	public native void Delay (int time);
	public native void BeginWindowFrame ();
	public native void EndWindowFrame ();
	public native int GetWindowHeight();
	public native int GetWindowWidth();
	
	// spritesets management 
	public native int LoadSpriteset (String name);
	public native int CloneSpriteset (int src);
	public native boolean GetSpriteInfo (int spriteset, int entry, SpriteInfo info);
	public native int GetSpritesetPalette (int spriteset);
	public native boolean DeleteSpriteset (int spriteset);	
	
	// tilesets management 
	public native int LoadTileset (String filename);
	public native int CloneTileset (int src);
	public native boolean SetTilesetPixels (int tileset, int entry, byte[] srcdata, int srcpitch);
	public native boolean CopyTile (int tileset, int src, int dst);	
	public native int GetTileWidth (int tileset);
	public native int GetTileHeight (int tileset);
	public native int GetTilesetPalette (int tileset);
	public native boolean DeleteTileset (int tileset);
	public native int GetTilesetNumTiles (int tileset);
	
	// tilemaps management 
	public native int LoadTilemap (String filename, String layername);
	public native int CloneTilemap (int src);
	public native int GetTilemapRows (int tilemap);
	public native int GetTilemapCols (int tilemap);
	public native boolean GetTilemapTile (int tilemap, int row, int col, Tile tile);
	public native boolean SetTilemapTile (int tilemap, int row, int col, Tile tile);
	public native void CopyTiles (int src, int srcrow, int srccol, int rows, int cols, int dst, int dstrow, int dstcol);
	public native boolean DeleteTilemap (int tilemap);

	// color tables management 
	public native int CreatePalette (int entries);
	public native int LoadPalette (String filename);
	public native int ClonePalette (int src);
	public native void DeletePalette (int palette);
	public native void SetPaletteColor (int palette, int color, byte r, byte g, byte b);
	public native void MixPalettes (int src1, int src2, int dst, byte f);
	
	// bitmaps 
	public native int CreateBitmap (int width, int height, int bpp);
	public native int LoadBitmap (String filename);
	public native int CloneBitmap (int src);
	public native int GetBitmapWidth (int bitmap);
	public native int GetBitmapHeight (int bitmap);
	public native int GetBitmapDepth (int bitmap);
	public native int GetBitmapPitch (int bitmap);
	public native int GetBitmapPalette (int bitmap);
	public native boolean SetBitmapPalette (int bitmap, int palette);
	public native boolean DeleteBitmap (int bitmap);

	// layer management 
	public native boolean SetLayer (int nlayer, int tileset, int tilemap);
	public native boolean SetLayerPalette (int nlayer, int palette);
	public native boolean SetLayerPosition (int nlayer, int hstart, int vstart);
	public native boolean SetLayerScaling (int nlayer, float xfactor, float yfactor);
	public native boolean SetLayerAffineTransform (int nlayer, Affine affine);
	public native boolean SetLayerTransform (int layer, float angle, float dx, float dy, float sx, float sy);
	public native boolean SetLayerBlendMode (int nlayer, int mode, byte factor);
	public native boolean SetLayerColumnOffset (int nlayer, int[] offset);
	public native boolean SetLayerClip (int nlayer, int x1, int y1, int x2, int y2);
	public native boolean DisableLayerClip (int nlayer);
	public native boolean ResetLayerMode (int nlayer);
	public native boolean DisableLayer (int nlayer);
	public native int GetLayerPalette (int nlayer);
	public native boolean GetLayerTile (int nlayer, int x, int y, TileInfo info);
	public native boolean SetLayerPriority (int nlayer, boolean enable);
	public native boolean SetLayerParent (int nlayer, int parent);
	public native boolean DisableLayerParent (int nlayer);
	public native boolean SetLayerTilemap (int nlayer, int tilemap);
	public native boolean SetLayerMosaic (int nlayer, int width, int height);
	public native boolean DisableLayerMosaic (int nlayer);
	public native int GetLayerWidth (int nlayer);
	public native int GetLayerHeight (int nlayer);

	// sprites management 
	public native boolean ConfigSprite (int nsprite, int spriteset, short flags);
	public native boolean SetSpriteSet (int nsprite, int spriteset);
	public native boolean SetSpriteFlags (int nsprite, short flags);
	public native boolean SetSpritePosition (int nsprite, int x, int y);
	public native boolean SetSpritePicture (int nsprite, int entry);
	public native boolean SetSpritePalette (int nsprite, int palette);
	public native boolean SetSpriteBlendMode (int nsprite, int mode, byte factor);
	public native boolean SetSpriteScaling (int nsprite, float sx, float sy);
	public native boolean ResetSpriteScaling (int nsprite);
	public native int GetSpritePicture (int nsprite);
	public native int GetAvailableSprite ();
	public native boolean EnableSpriteCollision (int nsprite, boolean enable);
	public native boolean GetSpriteCollision (int nsprite);
	public native boolean DisableSprite (int nsprite);
	public native int GetSpritePalette (int nsprite);
	public native boolean EnableSpriteFlag (int nsprite, short flag, boolean enable);
	public native boolean SetFirstSprite (int nsprite);
	public native boolean SetNextSprite (int nsprite, int next);
	public native boolean EnableSpriteMasking (int nsprite, boolean enable);
	public native void SetSpritesMaskingRegion (int top_line, int bottom_line);
	public native boolean SetSpriteAnimation (int nsprite, int sequence, int loop);
	public native boolean DisableSpriteAnimation (int nsprite);

	// sequences management 
	public native int CloneSequence (int src);
	public native boolean DeleteSequence (int sequence);
	
	// sequence pack management 
	public native int CreateSequencePack ();
	public native int LoadSequencePack (String filename);
	public native int FindSequence (int sp, String name);
	public native boolean AddSequenceToPack (int sp, int sequence);
	public native boolean DeleteSequencePack (int sp);

	// animation engine 
	public native boolean SetPaletteAnimation (int index, int palette, int sequence, boolean blend);
	public native boolean SetPaletteAnimationSource (int index, int palette);
	public native boolean GetAnimationState (int index);
	public native boolean SetAnimationDelay (int index, int frame, int delay);
	public native int GetAvailableAnimation ();
	public native boolean DisablePaletteAnimation (int index);	

	// updated functions

}