Package com.raylib

Class Image

java.lang.Object

com.raylib.Image

public class Image
extends Object

Image, pixel data stored in CPU memory (RAM)

Field Summary

Fields

Modifier and Type	Field	Description
final MemorySegment	memorySegment	The native FFI MemorySegment that holds the data this object wraps.

Constructor Summary

Constructors

Constructor	Description
Image()	Construct with auto memory allocator and fields initialized to zero.
Image(MemorySegment memorySegment)	Construct by wrapping around an already allocated MemorySegment, perhaps from another object
Image(MemorySegment data, int width, int height, int mipmaps, int format)	Construct with auto memory allocator and fields initialized as specified
Image(SegmentAllocator arena)	Construct with your owm memory allocator and fields not initialized
Image(SegmentAllocator arena, MemorySegment data, int width, int height, int mipmaps, int format)	Construct with your own memory allocator and fields initialized as specified

Method Summary

Modifier and Type	Method	Description
static Image	allocateArray(long elementCount)	Allocate an array of Image
static Image	allocateArray(long elementCount, SegmentAllocator allocator)	Allocate an array of Image
boolean	equals(Object o)	Equality is tested on basis of both wrapper objects must refer to same native memory location to be considered equal
Image	getArrayElement(int index)
MemorySegment	getData()	Image raw data
int	getFormat()	Data format (PixelFormat type)
int	getHeight()	Image base height
int	getMipmaps()	Mipmap levels, 1 by default
int	getWidth()	Image base width
int	hashCode()
Image	setData(MemorySegment value)	Image raw data
Image	setFormat(int value)	Data format (PixelFormat type)
Image	setHeight(int value)	Image base height
Image	setMipmaps(int value)	Mipmap levels, 1 by default
Image	setWidth(int value)	Image base width

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

memorySegment

public final MemorySegment memorySegment

The native FFI MemorySegment that holds the data this object wraps.

Constructor Details

Image

public Image()

Construct with auto memory allocator and fields initialized to zero.

Image

public Image(SegmentAllocator arena)

Construct with your owm memory allocator and fields not initialized

Image

public Image(MemorySegment memorySegment)

Construct by wrapping around an already allocated MemorySegment, perhaps from another object

Image

public Image(MemorySegment data,
 int width,
 int height,
 int mipmaps,
 int format)

Construct with auto memory allocator and fields initialized as specified

Parameters:

data - Image raw data

width - Image base width

height - Image base height

mipmaps - Mipmap levels, 1 by default

format - Data format (PixelFormat type)

Image

public Image(SegmentAllocator arena,
 MemorySegment data,
 int width,
 int height,
 int mipmaps,
 int format)

Construct with your own memory allocator and fields initialized as specified

Parameters:

data - Image raw data

width - Image base width

height - Image base height

mipmaps - Mipmap levels, 1 by default

format - Data format (PixelFormat type)

Method Details

equals

public boolean equals(Object o)

Equality is tested on basis of both wrapper objects must refer to same native memory location to be considered equal

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getArrayElement

public Image getArrayElement(int index)

allocateArray

public static Image allocateArray(long elementCount,
 SegmentAllocator allocator)

Allocate an array of Image

allocateArray

public static Image allocateArray(long elementCount)

Allocate an array of Image

getData

public MemorySegment getData()

Image raw data

setData

public Image setData(MemorySegment value)

Image raw data

getWidth

public int getWidth()

Image base width

setWidth

public Image setWidth(int value)

Image base width

getHeight

public int getHeight()

Image base height

setHeight

public Image setHeight(int value)

Image base height

getMipmaps

public int getMipmaps()

Mipmap levels, 1 by default

setMipmaps

public Image setMipmaps(int value)

Mipmap levels, 1 by default

getFormat

public int getFormat()

Data format (PixelFormat type)

setFormat

public Image setFormat(int value)

Data format (PixelFormat type)