Beatmup engine context. More...

Inheritance diagram for Beatmup.Context:

Public Member Functions
float	performTask (Task task) throws CoreException
	Performs a given task in the main thread pool. More...

float	performTask (Task task, int poolIndex) throws CoreException
	Performs a given task. More...

void	repeatTask (Task task, boolean abortCurrent)
	Ensures a given task executed at least once. More...

void	repeatTask (Task task, boolean abortCurrent, int poolIndex)
	Ensures a given task executed at least once in a specific thread pool. More...

int	submitPersistentTask (Task task)
	Submits a persistent task in the main thread pool. More...

int	submitPersistentTask (Task task, int poolIndex)
	Submits a persistent task in a specified thread pool. More...

void	waitForJob (int job)
	Blocks until a given job in the main thread pool finishes. More...

void	waitForJob (int job, int poolIndex)
	Blocks until a given job in the main thread pool finishes. More...

boolean	abortJob (int job)
	Aborts a given submitted job. More...

boolean	abortJob (int job, int poolIndex)
	Aborts a given submitted job. More...

void	limitWorkerCount (int newCount)
	Sets maximum number of threads executing tasks in the main thread pool. More...

void	limitWorkerCount (int newCount, int poolIndex)
	Sets maximum number of threads executing tasks in a given thread pool. More...

void	check () throws CoreException
	Checks if the main thread pool is doing great: rethrows exceptions occurred during tasks execution, if any. More...

void	check (int poolIndex) throws CoreException
	Checks if a specific thread pool is doing great: rethrows exceptions occurred during tasks execution, if any. More...

synchronized void	dispose ()
	Destroys the native object. More...

Bitmap	renderChessboard (int width, int height, int cellSize, PixelFormat pixelFormat)
	Renders a chessboard-like image. More...

Bitmap	copyBitmap (Bitmap source, PixelFormat pixelFormat)
	Creates a copy of given bitmap. More...

IntPoint	scanlineSearch (Bitmap bitmap, Color color, IntPoint start)
	Goes through a bitmap in scanline order (left to right, top to bottom) until a pixel of a given color is met. More...

boolean	isGPUQueried ()
	Tests whether the GPU was already queried. More...

boolean	isGPUReady ()
	Tests whether the GPU was already queried and successfully initialized. More...

void	recycleGPUGarbage ()
	Recycles GPU-managed resources that are ready to be disposed in a separate task. More...

Static Public Member Functions
static long	getTotalRAMBytes ()

Static Public Attributes
static final IntPoint	SCANLINE_SEARCH_NOT_FOUND = new IntPoint(-1, -1)
	Returned by Beatmup.Context.scanlineSearch() if no pixel of a specific color is found in the image. More...

Protected Member Functions
	Context (long handle)
	Creates a new context. More...

void	watchBitmap (Bitmap bitmap)
	Adds a bitmap to the watch list. More...

synchronized void	unwatchBitmap (Bitmap bitmap)
	Removes a bitmap from the watch list. More...

Additional Inherited Members
Protected Attributes inherited from Beatmup.Object
long	handle
	pointer to the native object More...

Detailed Description

Beatmup engine context.

Handles necessary data to interact with the engine through JNI layer

Definition at line 34 of file Context.java.

Constructor & Destructor Documentation

◆ Context()

Beatmup.Context.Context ( long handle )

inlineprotected

Creates a new context.

Definition at line 219 of file Context.java.

                                    {
         super(handle);
         eventListenerHandle = attachEventListener(handle);
         bitmaps = new HashMap<>();
     }

Member Function Documentation

◆ performTask() [1/2]

float Beatmup.Context.performTask ( Task task ) throws CoreException

inline

Performs a given task in the main thread pool.

Parameters

task	The task to run

Returns: execution time in ms.

Exceptions

CoreException if the main thread pool has unprocessed exceptions thrown by previously executed tasks.

Definition at line 78 of file Context.java.

                                                              {
         return performTask(handle, 0, task);
     }

◆ performTask() [2/2]

float Beatmup.Context.performTask	(	Task	task,
		int	poolIndex
	)		throws CoreException

inline

Performs a given task.

Parameters

task	The task to run
poolIndex	Zero-based index of the thread pool to run the task in.

Returns: execution time in ms.

Exceptions

CoreException if the thread pool has unprocessed exceptions thrown by previously executed tasks.

Definition at line 90 of file Context.java.

                                                                             {
         return performTask(handle, poolIndex, task);
     }

◆ repeatTask() [1/2]

void Beatmup.Context.repeatTask	(	Task	task,
		boolean	abortCurrent
	)

inline

Ensures a given task executed at least once.

Parameters

task	the task
abortCurrent	if `true` and a task is running, the abort signal is sent.

Definition at line 100 of file Context.java.

                                                             {
         repeatTask(handle, 0, task, abortCurrent);
     }

◆ repeatTask() [2/2]

void Beatmup.Context.repeatTask	(	Task	task,
		boolean	abortCurrent,
		int	poolIndex
	)

inline

Ensures a given task executed at least once in a specific thread pool.

Parameters

task	The task
abortCurrent	if `true` and a task is running, the abort signal is sent.
poolIndex	Index of the thread pool to run the task in

Definition at line 111 of file Context.java.

                                                                            {
         repeatTask(handle, poolIndex, task, abortCurrent);
     }

◆ submitPersistentTask() [1/2]

int Beatmup.Context.submitPersistentTask ( Task task )

inline

Submits a persistent task in the main thread pool.

Parameters

task The task

Returns: job index

Definition at line 121 of file Context.java.

                                                {
         return submitPersistentTask(handle, 0, task);
     }

◆ submitPersistentTask() [2/2]

int Beatmup.Context.submitPersistentTask	(	Task	task,
		int	poolIndex
	)

inline

Submits a persistent task in a specified thread pool.

Parameters

task	The task
poolIndex	Thread pool index

Returns: job index

Definition at line 132 of file Context.java.

                                                               {
         return submitPersistentTask(handle, poolIndex, task);
     }

◆ waitForJob() [1/2]

void Beatmup.Context.waitForJob ( int job )

inline

Blocks until a given job in the main thread pool finishes.

Parameters

job The job

Definition at line 141 of file Context.java.

                                     {
         waitForJob(handle, 0, job);
     }

◆ waitForJob() [2/2]

void Beatmup.Context.waitForJob	(	int	job,
		int	poolIndex
	)

inline

Blocks until a given job in the main thread pool finishes.

Parameters

job	The job
poolIndex	Thread pool index

Definition at line 151 of file Context.java.

                                                    {
         waitForJob(handle, poolIndex, job);
     }

◆ abortJob() [1/2]

boolean Beatmup.Context.abortJob ( int job )

inline

Aborts a given submitted job.

Parameters

job The job

Returns: true if the job was interrupted while running.

Definition at line 161 of file Context.java.

                                      {
         return abortJob(handle, 0, job);
     }

◆ abortJob() [2/2]

boolean Beatmup.Context.abortJob	(	int	job,
		int	poolIndex
	)

inline

Aborts a given submitted job.

Parameters

job	The job
poolIndex	Thread pool index

Returns: true if the job was interrupted while running.

Definition at line 172 of file Context.java.

                                                     {
         return abortJob(handle, poolIndex, job);
     }

◆ limitWorkerCount() [1/2]

void Beatmup.Context.limitWorkerCount ( int newCount )

inline

Sets maximum number of threads executing tasks in the main thread pool.

Parameters

newCount the new thread count limit

Definition at line 181 of file Context.java.

                                                {
         limitWorkerCount(handle, 0, newCount);
     }

◆ limitWorkerCount() [2/2]

void Beatmup.Context.limitWorkerCount	(	int	newCount,
		int	poolIndex
	)

inline

Sets maximum number of threads executing tasks in a given thread pool.

Parameters

newCount	the new thread count limit
poolIndex	index of the thread pool

Definition at line 191 of file Context.java.

                                                               {
         limitWorkerCount(handle, poolIndex, newCount);
     }

◆ check() [1/2]

void Beatmup.Context.check ( ) throws CoreException

inline

Checks if the main thread pool is doing great: rethrows exceptions occurred during tasks execution, if any.

If no exception is thrown, the thread pool is okay.

Exceptions

CoreException occurred while running a task.

Definition at line 201 of file Context.java.

                                              {
         check(handle, 0);
     }

◆ check() [2/2]

void Beatmup.Context.check ( int poolIndex ) throws CoreException

inline

Checks if a specific thread pool is doing great: rethrows exceptions occurred during tasks execution, if any.

If no exception is thrown, the thread pool is okay.

Parameters

poolIndex The thread pool index

Exceptions

CoreException occurred while running a task.

Definition at line 212 of file Context.java.

                                                           {
         check(handle, poolIndex);
     }

◆ watchBitmap()

void Beatmup.Context.watchBitmap ( Bitmap bitmap )

inlineprotected

Adds a bitmap to the watch list.

Parameters

bitmap the new bitmap

Definition at line 230 of file Context.java.

                                               {
         synchronized (bitmaps) {
             bitmaps.put(bitmap.handle, bitmap);
         }
     }

◆ unwatchBitmap()

synchronized void Beatmup.Context.unwatchBitmap ( Bitmap bitmap )

inlineprotected

Removes a bitmap from the watch list.

Parameters

bitmap the bitmap to remove

Definition at line 241 of file Context.java.

                                                              {
         synchronized (bitmaps) {
             bitmaps.remove(bitmap.handle);
         }
     }

◆ dispose()

synchronized void Beatmup.Context.dispose ( )

inline

Destroys the native object.

After the native object is destroyed, its Java counterpart likely becomes unusable.

Reimplemented from Beatmup.Object.

Reimplemented in Beatmup.Android.Context.

Definition at line 249 of file Context.java.

                                        {
         synchronized (bitmaps) {
             for (Bitmap bitmap : bitmaps.values()) {
                 bitmap.dispose();
             }
         }
         recycleGPUGarbage();
         super.dispose();
         detachEventListener(eventListenerHandle);
     }

◆ renderChessboard()

Bitmap Beatmup.Context.renderChessboard	(	int	width,
		int	height,
		int	cellSize,
		PixelFormat	pixelFormat
	)

inline

Renders a chessboard-like image.

Parameters

width	output image width in pixels
height	output image height in pixels
cellSize	chessboard cell size size in pixels
pixelFormat	output image pixel format

Returns: image of chessboard with cells aligned with topleft corner

Definition at line 269 of file Context.java.

                                                                                                  {
         return new Bitmap(
                 this,
                 renderChessboard(handle, width, height, cellSize, pixelFormat.ordinal())
         );
     }

◆ copyBitmap()

Bitmap Beatmup.Context.copyBitmap	(	Bitmap	source,
		PixelFormat	pixelFormat
	)

inline

Creates a copy of given bitmap.

Parameters

source	the bitmap
pixelFormat	pixel format of the copy

Returns: copy of the bitmap in the given pixel format

Definition at line 283 of file Context.java.

                                                                      {
         return new Bitmap(this, copyBitmap(source, pixelFormat.ordinal()));
     }

◆ scanlineSearch()

IntPoint Beatmup.Context.scanlineSearch	(	Bitmap	bitmap,
		Color	color,
		IntPoint	start
	)

inline

Goes through a bitmap in scanline order (left to right, top to bottom) until a pixel of a given color is met.

Parameters

bitmap	the bitmap to scan
color	the color value to look for
start	starting pixel position

Returns: pixel position coming after the starting point in the scaline order, or SCANLINE_SEARCH_NOT_FOUND if no such pixel found till the end (right-bottom bitmap corner).

Definition at line 296 of file Context.java.

                                                                                {
         return scanlineSearchInt(bitmap.handle, start.x, start.y, color.r, color.g, color.b, color.a);
     }

◆ isGPUQueried()

boolean Beatmup.Context.isGPUQueried ( )

inline

Tests whether the GPU was already queried.

Returns: true if the GPU was queried

Definition at line 309 of file Context.java.

                                   {
         return isGPUQueried(handle);
     }

◆ isGPUReady()

boolean Beatmup.Context.isGPUReady ( )

inline

Tests whether the GPU was already queried and successfully initialized.

Returns: true if yes

Definition at line 318 of file Context.java.

                                 {
         return isGPUReady(handle);
     }

◆ recycleGPUGarbage()

void Beatmup.Context.recycleGPUGarbage ( )

inline

Recycles GPU-managed resources that are ready to be disposed in a separate task.

Definition at line 326 of file Context.java.

                                     {
         recycleGPUGarbage(handle);
     }

◆ getTotalRAMBytes()

static long Beatmup.Context.getTotalRAMBytes ( )

inlinestatic

Returns: total size of RAM in bytes

Definition at line 334 of file Context.java.

                                           {
         return getTotalRam();
     }

Member Data Documentation

◆ SCANLINE_SEARCH_NOT_FOUND

final IntPoint Beatmup.Context.SCANLINE_SEARCH_NOT_FOUND = new IntPoint(-1, -1)

static

Returned by Beatmup.Context.scanlineSearch() if no pixel of a specific color is found in the image.

Definition at line 341 of file Context.java.

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

android/lib/src/main/java/Beatmup/Context.java

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Context()

Member Function Documentation

◆ performTask() [1/2]

◆ performTask() [2/2]

◆ repeatTask() [1/2]

◆ repeatTask() [2/2]

◆ submitPersistentTask() [1/2]

◆ submitPersistentTask() [2/2]

◆ waitForJob() [1/2]

◆ waitForJob() [2/2]

◆ abortJob() [1/2]

◆ abortJob() [2/2]

◆ limitWorkerCount() [1/2]

◆ limitWorkerCount() [2/2]

◆ check() [1/2]

◆ check() [2/2]

◆ watchBitmap()

◆ unwatchBitmap()

◆ dispose()

◆ renderChessboard()

◆ copyBitmap()

◆ scanlineSearch()

◆ isGPUQueried()

◆ isGPUReady()

◆ recycleGPUGarbage()

◆ getTotalRAMBytes()

Member Data Documentation

◆ SCANLINE_SEARCH_NOT_FOUND