PlatformUtils (mini2Dx-core 2.0.0-beta.7 API)

java.lang.Object
- org.mini2Dx.core.PlatformUtils

Direct Known Subclasses:: JvmPlatformUtils

public abstract class PlatformUtils
extends java.lang.Object

Constructor Summary

Constructors
Constructor and Description

PlatformUtils()

Constructors
Constructor and Description
`PlatformUtils()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract void`	`cancelPerformanceMode()` Cancels performance mode on the device.
`abstract long`	`currentTimeMillis()` Platform independent version of `System.currentTimeMillis()`
`abstract ZlibStream`	`decompress(byte[] compressedData)` Returns a `ZlibStream` to decompress data
`abstract void`	`enablePerformanceMode()` Enables performance mode on the device.
`abstract void`	`exit(boolean ignorePlatformRestrictions)` Exits the game
`abstract long`	`getAvailableMemory()` Gets the total memory available for the game
`double`	`getAverageFrameDuration()` Returns the average duration of frames (update/interpolate/render/flush)
`double`	`getAverageFrameInterval()` Returns the average interval of frames (the delta)
`double`	`getAverageInterpolateDuration()` Returns the average duration of interpolate()
`double`	`getAverageRenderDuration()` Returns the average duration of render(`Graphics`)
`double`	`getAverageUpdateDuration()` Returns the average duration of update()
`int`	`getFramesPerSecond()` Returns the number of frames per second
`double`	`getMaxFrameDuration()` Returns the max duration of frames (update/interpolate/render/flush) in the last second
`double`	`getMaxInterpolateDuration()` Returns the maximum interpolate() duration in the last second
`double`	`getMaxRenderDuration()` Returns the maximum render() duration in the last second
`double`	`getMaxUpdateDuration()` Returns the maximum update() duration in the last second
`abstract long`	`getTotalMemory()` Gets the total memory that can be used by the game
`int`	`getUpdatesPerSecond()` Returns the number of updates per second
`int`	`getUpdatesThisSecond()` Returns the number of frames that have occurred so far this second
`abstract long`	`getUsedMemory()` Gets the total memory used by the game
`abstract boolean`	`isGameThread()` Indicates if the current thread is the game thread
`void`	`markFrameBegin()` Internal usage only: marks a new frame
`void`	`markFrameEnd()`
`void`	`markInterpolateBegin()` Internal usage only: marks the beginning of interpolate operations
`void`	`markInterpolateEnd()` Internal usage only: marks the end of interpolate operations
`void`	`markRenderBegin()` Internal usage only: marks the beginning of rendering operations
`void`	`markRenderEnd()` Internal usage only: marks the end of rendering operations
`void`	`markUpdateBegin()` Internal usage only: marks the beginning of update operations
`void`	`markUpdateEnd()` Internal usage only: marks the end of update operations
`abstract long`	`nanoTime()` Platform independent version of `System.nanoTime()`
`abstract java.lang.String`	`timestampToDateFormat(long millis, java.lang.String format)` Converts a timestamp to the specified date format

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PlatformUtils
```
public PlatformUtils()
```
- Method Detail
  - exit
```
public abstract void exit(boolean ignorePlatformRestrictions)
```
    Exits the game
    
    Parameters:
    
    ignorePlatformRestrictions - exit even if platform rules don't permit exiting programmatically. Should be used only for debug purposes and always set to false for release builds.
  - nanoTime
```
public abstract long nanoTime()
```
    Platform independent version of System.nanoTime()
    
    See Also:
    
    System.nanoTime()
  - currentTimeMillis
```
public abstract long currentTimeMillis()
```
    Platform independent version of System.currentTimeMillis()
    
    See Also:
    
    System.currentTimeMillis()
  - getTotalMemory
```
public abstract long getTotalMemory()
```
    Gets the total memory that can be used by the game
    
    Returns:
    
    Number of bytes that can be used by the game
  - getAvailableMemory
```
public abstract long getAvailableMemory()
```
    Gets the total memory available for the game
    
    Returns:
    
    Number of bytes available for the game
  - getUsedMemory
```
public abstract long getUsedMemory()
```
    Gets the total memory used by the game
    
    Returns:
    
    Number of bytes used by the game
  - isGameThread
```
public abstract boolean isGameThread()
```
    Indicates if the current thread is the game thread
    
    Returns:
    
    if the current thread is the game thread
  - enablePerformanceMode
```
public abstract void enablePerformanceMode()
```
    Enables performance mode on the device. Depending on the device, this may be disabled by the OS at any time. This is best used to temporarily boost performance during asset loading. On devices where this is not supported, this does nothing.
  - cancelPerformanceMode
```
public abstract void cancelPerformanceMode()
```
    Cancels performance mode on the device. If performance mode was already cancelled by the OS, this does nothing. On devices where this is not supported, this does nothing.
  - markUpdateBegin
```
public void markUpdateBegin()
```
    Internal usage only: marks the beginning of update operations
  - markInterpolateBegin
```
public void markInterpolateBegin()
```
    Internal usage only: marks the beginning of interpolate operations
  - markInterpolateEnd
```
public void markInterpolateEnd()
```
    Internal usage only: marks the end of interpolate operations
  - markRenderBegin
```
public void markRenderBegin()
```
    Internal usage only: marks the beginning of rendering operations
  - markRenderEnd
```
public void markRenderEnd()
```
    Internal usage only: marks the end of rendering operations
  - markUpdateEnd
```
public void markUpdateEnd()
```
    Internal usage only: marks the end of update operations
  - markFrameBegin
```
public void markFrameBegin()
```
    Internal usage only: marks a new frame
  - markFrameEnd
```
public void markFrameEnd()
```
  - getUpdatesPerSecond
```
public int getUpdatesPerSecond()
```
    Returns the number of updates per second
    
    Returns:
    
    The number of updates per second
  - getFramesPerSecond
```
public int getFramesPerSecond()
```
    Returns the number of frames per second
    
    Returns:
    
    the number of frames per second
  - getUpdatesThisSecond
```
public int getUpdatesThisSecond()
```
    Returns the number of frames that have occurred so far this second
    
    Returns:
  - getAverageUpdateDuration
```
public double getAverageUpdateDuration()
```
    Returns the average duration of update()
    
    Returns:
    
    The average duration in nanoseconds
  - getMaxUpdateDuration
```
public double getMaxUpdateDuration()
```
    Returns the maximum update() duration in the last second
    
    Returns:
    
    The duration in nanoseconds
  - getAverageInterpolateDuration
```
public double getAverageInterpolateDuration()
```
    Returns the average duration of interpolate()
    
    Returns:
    
    The average duration in nanoseconds
  - getMaxInterpolateDuration
```
public double getMaxInterpolateDuration()
```
    Returns the maximum interpolate() duration in the last second
    
    Returns:
    
    The duration in nanoseconds
  - getAverageRenderDuration
```
public double getAverageRenderDuration()
```
    Returns the average duration of render(Graphics)
    
    Returns:
    
    The average duration in nanoseconds
  - getMaxRenderDuration
```
public double getMaxRenderDuration()
```
    Returns the maximum render() duration in the last second
    
    Returns:
    
    The duration in nanoseconds
  - getAverageFrameInterval
```
public double getAverageFrameInterval()
```
    Returns the average interval of frames (the delta)
    
    Returns:
    
    The average interval in nanoseconds
  - getAverageFrameDuration
```
public double getAverageFrameDuration()
```
    Returns the average duration of frames (update/interpolate/render/flush)
    
    Returns:
    
    The average duration in nanoseconds
  - getMaxFrameDuration
```
public double getMaxFrameDuration()
```
    Returns the max duration of frames (update/interpolate/render/flush) in the last second
    
    Returns:
    
    The duration in nanoseconds
  - decompress
```
public abstract ZlibStream decompress(byte[] compressedData)
```
    Returns a ZlibStream to decompress data
    
    Parameters:
    
    compressedData - The compressed data as a byte array
    
    Returns:
    
    A new ZlibStream instance
  - timestampToDateFormat
```
public abstract java.lang.String timestampToDateFormat(long millis,
                                                       java.lang.String format)
```
    Converts a timestamp to the specified date format
    
    Parameters:
    
    millis - The timestamp (in millis) to convert
    
    format - The date format (e.g. yyyy-MM-dd HH:mm:ss)
    
    Returns:
    
    The timestamp in the date format

Class PlatformUtils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PlatformUtils

Method Detail

exit

nanoTime

currentTimeMillis

getTotalMemory

getAvailableMemory

getUsedMemory

isGameThread

enablePerformanceMode

cancelPerformanceMode

markUpdateBegin

markInterpolateBegin

markInterpolateEnd

markRenderBegin

markRenderEnd

markUpdateEnd

markFrameBegin

markFrameEnd

getUpdatesPerSecond

getFramesPerSecond

getUpdatesThisSecond

getAverageUpdateDuration

getMaxUpdateDuration

getAverageInterpolateDuration

getMaxInterpolateDuration

getAverageRenderDuration

getMaxRenderDuration

getAverageFrameInterval

getAverageFrameDuration

getMaxFrameDuration

decompress

timestampToDateFormat