Kanzi Framework  3.9.0
Java API
BitmapImage Class Reference

BitmapImage is the basic runtime primitive to load, hold, and convert image data in memory. More...

Inheritance diagram for BitmapImage:
[legend]

Public Member Functions

 BitmapImage (int width, int height, GraphicsFormat format, String name)
 Creates a BitmapImage. More...
 
 BitmapImage (int width, int height, GraphicsFormat format, byte[] data, String name)
 Creates a BitmapImage. More...
 
GraphicsFormat getDataFormat ()
 Returns the GraphicsFormat of this BitmapImage. More...
 
long getHeight ()
 Returns the width of this BitmapImage. More...
 
long getHeight (long mipmapLevel)
 Returns the height of the given mipmaplevel of this BitmapImage. More...
 
long getMipmapLevelCount ()
 Returns the mipmap level count of this BitmapImage. More...
 
long getWidth ()
 Returns the width of this BitmapImage. More...
 
long getWidth (long mipmapLevel)
 Returns the width of the given mipmaplevel of this BitmapImage. More...
 

Detailed Description

BitmapImage is the basic runtime primitive to load, hold, and convert image data in memory.

Each image has width, height, pixel format, image data in memory, and can contain mipmap images.

To display an image, you must create a texture instance from that image. When you do so, you must transfer the ownership of the image to the texture instance using TextureBuilder.

Constructor & Destructor Documentation

◆ BitmapImage() [1/2]

BitmapImage ( int  width,
int  height,
GraphicsFormat  format,
String  name 
)

Creates a BitmapImage.

Parameters
widthWidth for this BitmapImage.
heightHeight for this BitmapImage.
formatGraphicsFormat for this BitmapImage.
nameName for this BitmapImage.

◆ BitmapImage() [2/2]

BitmapImage ( int  width,
int  height,
GraphicsFormat  format,
byte []  data,
String  name 
)

Creates a BitmapImage.

Parameters
widthWidth for this BitmapImage.
heightHeight for this BitmapImage.
formatGraphicsFormat for this BitmapImage.
dataData for this BitmapImage.
nameName for this BitmapImage.

Member Function Documentation

◆ getDataFormat()

GraphicsFormat getDataFormat ( )

Returns the GraphicsFormat of this BitmapImage.

Returns
The BitmapImage data's GraphicsFormat.

◆ getHeight() [1/2]

long getHeight ( )

Returns the width of this BitmapImage.

Returns
The BitmapImage's width.

◆ getHeight() [2/2]

long getHeight ( long  mipmapLevel)

Returns the height of the given mipmaplevel of this BitmapImage.

Parameters
mipmapLevelThe mipmap level of the BitmapImage to get the height of.
Returns
The BitmapImage's height of the given mipmaplevel.

◆ getMipmapLevelCount()

long getMipmapLevelCount ( )

Returns the mipmap level count of this BitmapImage.

Returns
The BitmapImage's mipmap level count.

◆ getWidth() [1/2]

long getWidth ( )

Returns the width of this BitmapImage.

Returns
The BitmapImage's width.

◆ getWidth() [2/2]

long getWidth ( long  mipmapLevel)

Returns the width of the given mipmaplevel of this BitmapImage.

Parameters
mipmapLevelThe mipmap level of the BitmapImage to get the width of.
Returns
The BitmapImage's width of the given mipmaplevel.