Image type, bpp always RGBA (32bit) More...

#include <Image.hpp>

Public Member Functions
	Image (const ::Font &font, const std::string_view text, float fontSize, float spacing, ::Color tint={255, 255, 255, 255})

	Image (const ::Image &image)

	Image (const ::Texture2D &texture)
	Load an image from the given file. More...

	Image (const Image &other)

	Image (const std::string_view fileName)
	Load an image from the given file. More...

	Image (const std::string_view fileName, int *frames)
	Load an animation image from the given file. More...

	Image (const std::string_view fileName, int width, int height, int format, int headerSize=0)
	Load a raw image from the given file, with the provided width, height, and formats. More...

	Image (const std::string_view fileName, std::span< int > frames)
	Load an animation image from the given file. More...

	Image (const std::string_view fileType, const unsigned char *fileData, int dataSize)
	Load an image from the given file. More...

	Image (const std::string_view text, int fontSize, ::Color color={255, 255, 255, 255})

	Image (Image &&other) noexcept

	Image (int width, int height, ::Color color={255, 255, 255, 255})

	Image (void *data=nullptr, int width=0, int height=0, int mipmaps=1, int format=PIXELFORMAT_UNCOMPRESSED_R8G8B8A8)

Image &	AlphaClear (::Color color, float threshold)
	Clear alpha channel to desired color. More...

Image &	AlphaCrop (float threshold)
	Crop image depending on alpha value. More...

Image &	AlphaMask (const ::Image &alphaMask)
	Apply alpha mask to image. More...

Image &	AlphaPremultiply ()
	Premultiply alpha channel. More...

::Image	Channel (int selectedChannel)
	Create an image from a selected channel of another image (GRAYSCALE) More...

Image &	ClearBackground (::Color color={0, 0, 0, 255})
	Clear image background with given color. More...

Image &	ColorBrightness (int brightness)
	Modify image color: brightness. More...

Image &	ColorContrast (float contrast)
	Modify image color: contrast. More...

Image &	ColorGrayscale ()
	Modify image color: grayscale. More...

Image &	ColorInvert ()
	Modify image color: invert. More...

Image &	ColorReplace (::Color color, ::Color replace)
	Modify image color: replace color. More...

Image &	ColorTint (::Color color={255, 255, 255, 255})
	Modify image color: tint. More...

::Image	Copy () const
	Create an image duplicate (useful for transformations) More...

Image &	Crop (::Rectangle crop)
	Crop an image to area defined by a rectangle. More...

Image &	Crop (::Vector2 size)
	Crop an image to a new given width and height based on a vector. More...

Image &	Crop (int newWidth, int newHeight)
	Crop an image to a new given width and height. More...

Image &	Crop (int offsetX, int offsetY, int newWidth, int newHeight)
	Crop an image to area defined by a rectangle. More...

Image &	Dither (int rBpp, int gBpp, int bBpp, int aBpp)
	Dither image data to 16bpp or lower (Floyd-Steinberg dithering) More...

void	Draw (const ::Image &src, ::Rectangle srcRec, ::Rectangle dstRec, ::Color tint={255, 255, 255, 255})

void	DrawCircle (::Vector2 center, int radius, ::Color color={255, 255, 255, 255})

void	DrawCircle (int centerX, int centerY, int radius, ::Color color={255, 255, 255, 255})

void	DrawLine (::Vector2 start, ::Vector2 end, ::Color color={255, 255, 255, 255})

void	DrawLine (::Vector2 start, ::Vector2 end, int thick, ::Color color={255, 255, 255, 255})
	Description: Draw a line defining thickness within an image. More...

void	DrawLine (int startPosX, int startPosY, int endPosX, int endPosY, ::Color color={255, 255, 255, 255})

void	DrawPixel (::Vector2 position, ::Color color={255, 255, 255, 255})

void	DrawPixel (int posX, int posY, ::Color color={255, 255, 255, 255})
	Draw pixel within an image. More...

void	DrawRectangle (::Rectangle rec, ::Color color={255, 255, 255, 255})

void	DrawRectangle (int posX, int posY, int width, int height, ::Color color={255, 255, 255, 255})

void	DrawRectangle (Vector2 position, Vector2 size, ::Color color={255, 255, 255, 255})

void	DrawRectangleLines (::Rectangle rec, int thick=1, ::Color color={255, 255, 255, 255})

void	DrawText (const ::Font &font, const char *text, ::Vector2 position, float fontSize, float spacing, ::Color tint={255, 255, 255, 255})

void	DrawText (const ::Font &font, const std::string_view text, ::Vector2 position, float fontSize, float spacing, ::Color tint={255, 255, 255, 255})

void	DrawText (const char *text, ::Vector2 position, int fontSize, ::Color color={255, 255, 255, 255})

void	DrawText (const char *text, int x, int y, int fontSize, ::Color color={255, 255, 255, 255})

void	DrawText (const std::string_view text, ::Vector2 position, int fontSize, ::Color color={255, 255, 255, 255})

void	DrawText (const std::string_view text, int x, int y, int fontSize, ::Color color={255, 255, 255, 255})

void	Export (const std::string_view fileName) const
	Export image data to file, returns true on success. More...

void	ExportAsCode (const std::string_view fileName) const
	Export image as code file defining an array of bytes, returns true on success. More...

unsigned char *	ExportToMemory (const char fileType, int fileSize)
	Export image to memory buffer. More...

unsigned char *	ExportToMemory (const std::string_view fileType, std::span< int > fileSize)

Image &	FlipHorizontal ()
	Flip image horizontally. More...

Image &	FlipVertical ()
	Flip image vertically. More...

Image &	Format (int newFormat)
	Convert image data to desired format. More...

::Image	FromImage (::Rectangle rec) const
	Create an image from another image piece. More...

Rectangle	GetAlphaBorder (float threshold) const
	Get image alpha border rectangle. More...

raylib::Color	GetColor (::Vector2 position) const
	Get image pixel color at vector position. More...

raylib::Color	GetColor (int x=0, int y=0) const
	Get image pixel color at (x, y) position. More...

void *	GetData () const
	Retrieves the data value for the object. More...

int	GetFormat () const
	Retrieves the format value for the object. More...

int	GetHeight () const
	Retrieves the height value for the object. More...

int	GetMipmaps () const
	Retrieves the mipmaps value for the object. More...

int	GetPixelDataSize () const
	Returns the pixel data size based on the current image. More...

::Vector2	GetSize () const
	Retrieve the width and height of the image. More...

int	GetWidth () const
	Retrieves the width value for the object. More...

bool	IsValid () const
	Retrieve whether or not the Image has been loaded. More...

void	KernelConvolution (const float *kernel, int kernelSize)
	Apply custom square convolution kernel to image. More...

void	Load (const ::Texture2D &texture)
	Load an image from the given file. More...

void	Load (const std::string_view fileName)
	Load image from file into CPU memory (RAM) More...

void	Load (const std::string_view fileName, int *frames)
	Load image sequence from file (frames appended to image.data). More...

void	Load (const std::string_view fileName, int width, int height, int format, int headerSize)
	Load image from RAW file data. More...

void	Load (const std::string_view fileName, std::span< int > frames)
	Load image sequence from file (frames appended to image.data). More...

void	Load (const std::string_view fileType, const std::span< unsigned char > fileData)
	Load image from memory buffer, fileType refers to extension: i.e. More...

void	Load (const std::string_view fileType, const unsigned char *fileData, int dataSize)
	Load image from memory buffer, fileType refers to extension: i.e. More...

::Color *	LoadColors () const
	Load color data from image as a Color array (RGBA - 32bit) More...

::Color *	LoadPalette (int maxPaletteSize, int *colorsCount) const
	Load colors palette from image as a Color array (RGBA - 32bit) More...

::Texture2D	LoadTexture () const
	Load texture from image data. More...

Image &	Mipmaps ()
	Generate all mipmap levels for a provided image. More...

	operator::Texture2D () const
	Loads a texture from the image data. More...

Image &	operator= (const ::Image &image)

Image &	operator= (const Image &other)

Image &	operator= (Image &&other) noexcept

Image &	Resize (int newWidth, int newHeight)
	Resize and image to new size. More...

Image &	ResizeCanvas (int newWidth, int newHeight, int offsetX=0, int offsetY=0, ::Color color={255, 255, 255, 255})
	Resize canvas and fill with color. More...

Image &	ResizeNN (int newWidth, int newHeight)
	Resize and image to new size using Nearest-Neighbor scaling algorithm. More...

Image &	Rotate (Degree degrees)
	Rotate image by input angle in degrees (-359 to 359) More...

Image &	RotateCCW ()
	Rotate image counter-clockwise 90deg. More...

Image &	RotateCW ()
	Rotate image clockwise 90deg. More...

void	SetHeight (int height, int offsetX=0, int offsetY=0, ::Color fill={255, 255, 255, 255})
	Set the height of the image canvas. More...

void	SetWidth (int width, int offsetX=0, int offsetY=0, ::Color fill={255, 255, 255, 255})
	Set the width of the image canvas. More...

Image &	ToPOT (::Color fillColor)
	Convert image to POT (power-of-two) More...

void	Unload ()
	Unload image from CPU memory (RAM) More...

void	UnloadColors (::Color *colors) const
	Unload color data loaded with LoadImageColors() More...

void	UnloadPalette (::Color *colors) const
	Unload colors palette loaded with LoadImagePalette() More...

Static Public Member Functions
::Image	Cellular (int width, int height, int tileSize)
	Generate image: cellular algorithm. More...

::Image	Checked (int width, int height, int checksX, int checksY, ::Color col1={255, 255, 255, 255}, ::Color col2={0, 0, 0, 255})
	Generate image: checked. More...

::Image	Color (int width, int height, ::Color color={255, 255, 255, 255})
	Generate image: plain color. More...

::Image	GetClipboard ()
	Get clipboard image content. More...

static int	GetPixelDataSize (int width, int height, int format=PIXELFORMAT_UNCOMPRESSED_R32G32B32A32)
	Get pixel data size in bytes for certain format. More...

::Image	GradientLinear (int width, int height, int direction, ::Color start, ::Color end)
	Generate image: linear gradient. More...

::Image	GradientRadial (int width, int height, float density, ::Color inner, ::Color outer)
	Generate image: radial gradient. More...

::Image	LoadFromScreen ()
	Get pixel data from screen buffer and return an Image (screenshot) More...

::Image	Text (const ::Font &font, const std::string_view text, float fontSize, float spacing, ::Color tint={255, 255, 255, 255})

::Image	Text (const std::string_view text, int fontSize, ::Color color={255, 255, 255, 255})

::Image	WhiteNoise (int width, int height, float factor)
	Generate image: white noise. More...

Protected Member Functions
void	set (const ::Image &image)

Detailed Description

Image type, bpp always RGBA (32bit)

Data stored in CPU memory (RAM)

Definition at line 19 of file Image.hpp.

Constructor & Destructor Documentation

◆ Image() [1/13]

raylib::Image::Image	(	void *	data = `nullptr`,
		int	width = `0`,
		int	height = `0`,
		int	mipmaps = `1`,
		int	format = `PIXELFORMAT_UNCOMPRESSED_R8G8B8A8`
	)

inline

Definition at line 21 of file Image.hpp.

◆ Image() [2/13]

raylib::Image::Image ( const ::Image & image )

inline

Definition at line 31 of file Image.hpp.

◆ Image() [3/13]

raylib::Image::Image ( const std::string_view fileName )

inline

Load an image from the given file.

Exceptions

raylib::RaylibException Thrown if the image failed to load from the file.

See also: Load()

Definition at line 40 of file Image.hpp.

References Load().

◆ Image() [4/13]

raylib::Image::Image	(	const std::string_view	fileName,
		int	width,
		int	height,
		int	format,
		int	headerSize = `0`
	)

inline

Load a raw image from the given file, with the provided width, height, and formats.

Exceptions

raylib::RaylibException Thrown if the image failed to load from the file.

See also: LoadRaw()

Definition at line 51 of file Image.hpp.

References Load().

◆ Image() [5/13]

raylib::Image::Image	(	const std::string_view	fileName,
		int *	frames
	)

inline

Load an animation image from the given file.

Exceptions

raylib::RaylibException Thrown if the image failed to load from the file.

See also: LoadAnim()

Definition at line 62 of file Image.hpp.

References Load().

◆ Image() [6/13]

raylib::Image::Image	(	const std::string_view	fileName,
		std::span< int >	frames
	)

inline

Load an animation image from the given file.

Exceptions

raylib::RaylibException Thrown if the image failed to load from the file.

See also: LoadAnim()

Definition at line 73 of file Image.hpp.

References Load().

◆ Image() [7/13]

raylib::Image::Image	(	const std::string_view	fileType,
		const unsigned char *	fileData,
		int	dataSize
	)

inline

Load an image from the given file.

Exceptions

raylib::RaylibException Thrown if the image failed to load from the file.

Definition at line 82 of file Image.hpp.

References Load().

◆ Image() [8/13]

raylib::Image::Image ( const ::Texture2D & texture )

inline

Load an image from the given file.

Exceptions

raylib::RaylibException Thrown if the image failed to load from the file.

Definition at line 91 of file Image.hpp.

References Load().

◆ Image() [9/13]

raylib::Image::Image	(	int	width,
		int	height,
		::Color	color = `{255, 255, 255, 255}`
	)

inline

Definition at line 93 of file Image.hpp.

◆ Image() [10/13]

raylib::Image::Image	(	const std::string_view	text,
		int	fontSize,
		::Color	color = `{255, 255, 255, 255}`
	)

inline

Definition at line 95 of file Image.hpp.

◆ Image() [11/13]

raylib::Image::Image	(	const ::Font &	font,
		const std::string_view	text,
		float	fontSize,
		float	spacing,
		::Color	tint = `{255, 255, 255, 255}`
	)

inline

Definition at line 99 of file Image.hpp.

◆ Image() [12/13]

raylib::Image::Image ( const Image & other )

inline

Definition at line 104 of file Image.hpp.

◆ Image() [13/13]

raylib::Image::Image ( Image && other )

inlinenoexcept

Definition at line 106 of file Image.hpp.

◆ ~Image()

raylib::Image::~Image ( )

inline

Definition at line 182 of file Image.hpp.

Member Function Documentation

◆ AlphaClear()

Image & raylib::Image::AlphaClear	(	::Color	color,
		float	threshold
	)

inline

Clear alpha channel to desired color.

Definition at line 437 of file Image.hpp.

◆ AlphaCrop()

Image & raylib::Image::AlphaCrop ( float threshold )

inline

Crop image depending on alpha value.

Definition at line 429 of file Image.hpp.

◆ AlphaMask()

Image & raylib::Image::AlphaMask ( const ::Image & alphaMask )

inline

Apply alpha mask to image.

Definition at line 445 of file Image.hpp.

◆ AlphaPremultiply()

Image & raylib::Image::AlphaPremultiply ( )

inline

Premultiply alpha channel.

Definition at line 453 of file Image.hpp.

◆ Cellular()

::Image raylib::Image::Cellular	(	int	width,
		int	height,
		int	tileSize
	)

inlinestatic

Generate image: cellular algorithm.

Bigger tileSize means bigger cells

Definition at line 175 of file Image.hpp.

◆ Channel()

::Image raylib::Image::Channel ( int selectedChannel )

inline

Create an image from a selected channel of another image (GRAYSCALE)

Definition at line 795 of file Image.hpp.

◆ Checked()

::Image raylib::Image::Checked	(	int	width,
		int	height,
		int	checksX,
		int	checksY,
		::Color	col1 = `{255, 255, 255, 255}`,
		::Color	col2 = `{0, 0, 0, 255}`
	)

inlinestatic

Generate image: checked.

Definition at line 155 of file Image.hpp.

◆ ClearBackground()

Image & raylib::Image::ClearBackground ( ::Color color = {0, 0, 0, 255} )

inline

Clear image background with given color.

Definition at line 638 of file Image.hpp.

◆ Color()

::Image raylib::Image::Color	(	int	width,
		int	height,
		::Color	color = `{255, 255, 255, 255}`
	)

inlinestatic

Generate image: plain color.

Definition at line 134 of file Image.hpp.

◆ ColorBrightness()

Image & raylib::Image::ColorBrightness ( int brightness )

inline

Modify image color: brightness.

Parameters

brightness Brightness values between -255 and 255

Definition at line 603 of file Image.hpp.

◆ ColorContrast()

Image & raylib::Image::ColorContrast ( float contrast )

inline

Modify image color: contrast.

Parameters

contrast Contrast values between -100 and 100

Definition at line 593 of file Image.hpp.

◆ ColorGrayscale()

Image & raylib::Image::ColorGrayscale ( )

inline

Modify image color: grayscale.

Definition at line 583 of file Image.hpp.

◆ ColorInvert()

Image & raylib::Image::ColorInvert ( )

inline

Modify image color: invert.

Definition at line 575 of file Image.hpp.

◆ ColorReplace()

Image & raylib::Image::ColorReplace	(	::Color	color,
		::Color	replace
	)

inline

Modify image color: replace color.

Definition at line 611 of file Image.hpp.

◆ ColorTint()

Image & raylib::Image::ColorTint ( ::Color color = {255, 255, 255, 255} )

inline

Modify image color: tint.

Definition at line 567 of file Image.hpp.

◆ Copy()

::Image raylib::Image::Copy ( ) const

inline

Create an image duplicate (useful for transformations)

Definition at line 395 of file Image.hpp.

◆ Crop() [1/4]

Image & raylib::Image::Crop ( ::Rectangle crop )

inline

Crop an image to area defined by a rectangle.

Definition at line 421 of file Image.hpp.

◆ Crop() [2/4]

Image & raylib::Image::Crop ( ::Vector2 size )

inline

Crop an image to a new given width and height based on a vector.

Definition at line 466 of file Image.hpp.

References Crop().

Referenced by Crop().

◆ Crop() [3/4]

Image & raylib::Image::Crop	(	int	newWidth,
		int	newHeight
	)

inline

Crop an image to a new given width and height.

Definition at line 461 of file Image.hpp.

References Crop().

Referenced by Crop().

◆ Crop() [4/4]

Image & raylib::Image::Crop	(	int	offsetX,
		int	offsetY,
		int	newWidth,
		int	newHeight
	)

inline

Crop an image to area defined by a rectangle.

Definition at line 471 of file Image.hpp.

◆ Dither()

Image & raylib::Image::Dither	(	int	rBpp,
		int	gBpp,
		int	bBpp,
		int	aBpp
	)

inline

Dither image data to 16bpp or lower (Floyd-Steinberg dithering)

Definition at line 517 of file Image.hpp.

◆ Draw()

void raylib::Image::Draw	(	const ::Image &	src,
		::Rectangle	srcRec,
		::Rectangle	dstRec,
		::Color	tint = `{255, 255, 255, 255}`
	)

inline

Definition at line 695 of file Image.hpp.

◆ DrawCircle() [1/2]

void raylib::Image::DrawCircle	(	::Vector2	center,
		int	radius,
		::Color	color = `{255, 255, 255, 255}`
	)

inline

Definition at line 673 of file Image.hpp.

◆ DrawCircle() [2/2]

void raylib::Image::DrawCircle	(	int	centerX,
		int	centerY,
		int	radius,
		::Color	color = `{255, 255, 255, 255}`
	)

inline

Definition at line 669 of file Image.hpp.

◆ DrawLine() [1/3]

void raylib::Image::DrawLine	(	::Vector2	start,
		::Vector2	end,
		::Color	color = `{255, 255, 255, 255}`
	)

inline

Definition at line 658 of file Image.hpp.

◆ DrawLine() [2/3]

void raylib::Image::DrawLine	(	::Vector2	start,
		::Vector2	end,
		int	thick,
		::Color	color = `{255, 255, 255, 255}`
	)

inline

Description: Draw a line defining thickness within an image.

Definition at line 665 of file Image.hpp.

◆ DrawLine() [3/3]

void raylib::Image::DrawLine	(	int	startPosX,
		int	startPosY,
		int	endPosX,
		int	endPosY,
		::Color	color = `{255, 255, 255, 255}`
	)

inline

Definition at line 654 of file Image.hpp.

◆ DrawPixel() [1/2]

void raylib::Image::DrawPixel	(	::Vector2	position,
		::Color	color = `{255, 255, 255, 255}`
	)

inline

Definition at line 650 of file Image.hpp.

◆ DrawPixel() [2/2]

void raylib::Image::DrawPixel	(	int	posX,
		int	posY,
		::Color	color = `{255, 255, 255, 255}`
	)

inline

Draw pixel within an image.

Definition at line 646 of file Image.hpp.

◆ DrawRectangle() [1/3]

void raylib::Image::DrawRectangle	(	::Rectangle	rec,
		::Color	color = `{255, 255, 255, 255}`
	)

inline

Definition at line 685 of file Image.hpp.

◆ DrawRectangle() [2/3]

void raylib::Image::DrawRectangle	(	int	posX,
		int	posY,
		int	width,
		int	height,
		::Color	color = `{255, 255, 255, 255}`
	)

inline

Definition at line 677 of file Image.hpp.

◆ DrawRectangle() [3/3]

void raylib::Image::DrawRectangle	(	Vector2	position,
		Vector2	size,
		::Color	color = `{255, 255, 255, 255}`
	)

inline

Definition at line 681 of file Image.hpp.

◆ DrawRectangleLines()

void raylib::Image::DrawRectangleLines	(	::Rectangle	rec,
		int	thick = `1`,
		::Color	color = `{255, 255, 255, 255}`
	)

inline

Definition at line 689 of file Image.hpp.

◆ DrawText() [1/6]

void raylib::Image::DrawText	(	const ::Font &	font,
		const char *	text,
		::Vector2	position,
		float	fontSize,
		float	spacing,
		::Color	tint = `{255, 255, 255, 255}`
	)

inline

Definition at line 727 of file Image.hpp.

◆ DrawText() [2/6]

void raylib::Image::DrawText	(	const ::Font &	font,
		const std::string_view	text,
		::Vector2	position,
		float	fontSize,
		float	spacing,
		::Color	tint = `{255, 255, 255, 255}`
	)

inline

Definition at line 722 of file Image.hpp.

◆ DrawText() [3/6]

void raylib::Image::DrawText	(	const char *	text,
		::Vector2	position,
		int	fontSize,
		::Color	color = `{255, 255, 255, 255}`
	)

inline

Definition at line 699 of file Image.hpp.

◆ DrawText() [4/6]

void raylib::Image::DrawText	(	const char *	text,
		int	x,
		int	y,
		int	fontSize,
		::Color	color = `{255, 255, 255, 255}`
	)

inline

Definition at line 718 of file Image.hpp.

◆ DrawText() [5/6]

void raylib::Image::DrawText	(	const std::string_view	text,
		::Vector2	position,
		int	fontSize,
		::Color	color = `{255, 255, 255, 255}`
	)

inline

Definition at line 703 of file Image.hpp.

◆ DrawText() [6/6]

void raylib::Image::DrawText	(	const std::string_view	text,
		int	x,
		int	y,
		int	fontSize,
		::Color	color = `{255, 255, 255, 255}`
	)

inline

Definition at line 713 of file Image.hpp.

◆ Export()

void raylib::Image::Export ( const std::string_view fileName ) const

inline

Export image data to file, returns true on success.

Exceptions

raylib::RaylibException Thrown if the image failed to load from the file.

Definition at line 335 of file Image.hpp.

References raylib::ExportImage().

◆ ExportAsCode()

void raylib::Image::ExportAsCode ( const std::string_view fileName ) const

inline

Export image as code file defining an array of bytes, returns true on success.

Exceptions

raylib::RaylibException Thrown if the image failed to load from the file.

Definition at line 357 of file Image.hpp.

References raylib::ExportImageAsCode().

◆ ExportToMemory() [1/2]

unsigned char * raylib::Image::ExportToMemory	(	const char *	fileType,
		int *	fileSize
	)

inline

Export image to memory buffer.

Definition at line 344 of file Image.hpp.

◆ ExportToMemory() [2/2]

unsigned char * raylib::Image::ExportToMemory	(	const std::string_view	fileType,
		std::span< int >	fileSize
	)

inline

Definition at line 348 of file Image.hpp.

◆ FlipHorizontal()

Image & raylib::Image::FlipHorizontal ( )

inline

Flip image horizontally.

Definition at line 533 of file Image.hpp.

◆ FlipVertical()

Image & raylib::Image::FlipVertical ( )

inline

Flip image vertically.

Definition at line 525 of file Image.hpp.

◆ Format()

Image & raylib::Image::Format ( int newFormat )

inline

Convert image data to desired format.

Definition at line 405 of file Image.hpp.

◆ FromImage()

::Image raylib::Image::FromImage ( ::Rectangle rec ) const

inline

Create an image from another image piece.

Definition at line 400 of file Image.hpp.

◆ GetAlphaBorder()

Rectangle raylib::Image::GetAlphaBorder ( float threshold ) const

inline

Get image alpha border rectangle.

Parameters

threshold Threshold is defined as a percentatge: 0.0f -> 1.0f

Definition at line 621 of file Image.hpp.

◆ GetClipboard()

::Image raylib::Image::GetClipboard ( )

inlinestatic

Get clipboard image content.

Definition at line 180 of file Image.hpp.

◆ GetColor() [1/2]

raylib::Color raylib::Image::GetColor ( ::Vector2 position ) const

inline

Get image pixel color at vector position.

Definition at line 631 of file Image.hpp.

◆ GetColor() [2/2]

raylib::Color raylib::Image::GetColor	(	int	x = `0`,
		int	y = `0`
	)		const

inline

Get image pixel color at (x, y) position.

Definition at line 626 of file Image.hpp.

◆ GetData()

void * raylib::Image::GetData ( ) const

inline

Retrieves the data value for the object.

Returns: The data value of the object.

Definition at line 363 of file Image.hpp.

◆ GetFormat()

int raylib::Image::GetFormat ( ) const

inline

Retrieves the format value for the object.

Returns: The format value of the object.

Definition at line 367 of file Image.hpp.

◆ GetHeight()

int raylib::Image::GetHeight ( ) const

inline

Retrieves the height value for the object.

Returns: The height value of the object.

Definition at line 365 of file Image.hpp.

◆ GetMipmaps()

int raylib::Image::GetMipmaps ( ) const

inline

Retrieves the mipmaps value for the object.

Returns: The mipmaps value of the object.

Definition at line 366 of file Image.hpp.

◆ GetPixelDataSize() [1/2]

int raylib::Image::GetPixelDataSize ( ) const

inline

Returns the pixel data size based on the current image.

Returns: The pixel data size of the image.

Definition at line 783 of file Image.hpp.

◆ GetPixelDataSize() [2/2]

static int raylib::Image::GetPixelDataSize	(	int	width,
		int	height,
		int	format = `PIXELFORMAT_UNCOMPRESSED_R32G32B32A32`
	)

inlinestatic

Get pixel data size in bytes for certain format.

Definition at line 774 of file Image.hpp.

◆ GetSize()

::Vector2 raylib::Image::GetSize ( ) const

inline

Retrieve the width and height of the image.

Definition at line 390 of file Image.hpp.

◆ GetWidth()

int raylib::Image::GetWidth ( ) const

inline

Retrieves the width value for the object.

Returns: The width value of the object.

Definition at line 364 of file Image.hpp.

◆ GradientLinear()

::Image raylib::Image::GradientLinear	(	int	width,
		int	height,
		int	direction,
		::Color	start,
		::Color	end
	)

inlinestatic

Generate image: linear gradient.

Definition at line 141 of file Image.hpp.

◆ GradientRadial()

::Image raylib::Image::GradientRadial	(	int	width,
		int	height,
		float	density,
		::Color	inner,
		::Color	outer
	)

inlinestatic

Generate image: radial gradient.

Definition at line 148 of file Image.hpp.

◆ IsValid()

bool raylib::Image::IsValid ( ) const

inline

Retrieve whether or not the Image has been loaded.

Returns: True or false depending on whether the Image has been loaded.

Definition at line 790 of file Image.hpp.

Referenced by Load().

◆ KernelConvolution()

void raylib::Image::KernelConvolution	(	const float *	kernel,
		int	kernelSize
	)

inline

Apply custom square convolution kernel to image.

Definition at line 800 of file Image.hpp.

◆ Load() [1/7]

void raylib::Image::Load ( const ::Texture2D & texture )

inline

Load an image from the given file.

Exceptions

raylib::RaylibException Thrown if the image animation to load from the file.

See also: ::LoadImageFromTexture()

Definition at line 313 of file Image.hpp.

References IsValid().

◆ Load() [2/7]

void raylib::Image::Load ( const std::string_view fileName )

inline

Load image from file into CPU memory (RAM)

Exceptions

raylib::RaylibException Thrown if the image failed to load from the file.

See also: LoadImage()

Definition at line 224 of file Image.hpp.

References IsValid(), and raylib::LoadImage().

Referenced by Image().

◆ Load() [3/7]

void raylib::Image::Load	(	const std::string_view	fileName,
		int *	frames
	)

inline

Load image sequence from file (frames appended to image.data).

Exceptions

raylib::RaylibException Thrown if the image animation to load from the file.

See also: LoadImageAnim()

Definition at line 252 of file Image.hpp.

References IsValid(), and raylib::LoadImageAnim().

◆ Load() [4/7]

void raylib::Image::Load	(	const std::string_view	fileName,
		int	width,
		int	height,
		int	format,
		int	headerSize
	)

inline

Load image from RAW file data.

Exceptions

raylib::RaylibException Thrown if the image failed to load from the file.

See also: LoadImageRaw()

Definition at line 238 of file Image.hpp.

References IsValid(), and raylib::LoadImageRaw().

◆ Load() [5/7]

void raylib::Image::Load	(	const std::string_view	fileName,
		std::span< int >	frames
	)

inline

Load image sequence from file (frames appended to image.data).

Exceptions

raylib::RaylibException Thrown if the image animation to load from the file.

See also: LoadImageAnim()

Definition at line 266 of file Image.hpp.

References IsValid(), and raylib::LoadImageAnim().

◆ Load() [6/7]

void raylib::Image::Load	(	const std::string_view	fileType,
		const std::span< unsigned char >	fileData
	)

inline

Load image from memory buffer, fileType refers to extension: i.e.

"png".

Exceptions

raylib::RaylibException Thrown if the image animation to load from the file.

See also: LoadImageFromMemory()

Definition at line 297 of file Image.hpp.

References IsValid(), and raylib::LoadImageFromMemory().

◆ Load() [7/7]

void raylib::Image::Load	(	const std::string_view	fileType,
		const unsigned char *	fileData,
		int	dataSize
	)

inline

Load image from memory buffer, fileType refers to extension: i.e.

"png".

Exceptions

raylib::RaylibException Thrown if the image animation to load from the file.

See also: LoadImageFromMemory()

Definition at line 280 of file Image.hpp.

References IsValid(), and raylib::LoadImageFromMemory().

◆ LoadColors()

::Color * raylib::Image::LoadColors ( ) const

inline

Load color data from image as a Color array (RGBA - 32bit)

Definition at line 740 of file Image.hpp.

◆ LoadFromScreen()

::Image raylib::Image::LoadFromScreen ( )

inlinestatic

Get pixel data from screen buffer and return an Image (screenshot)

Definition at line 129 of file Image.hpp.

◆ LoadPalette()

::Color * raylib::Image::LoadPalette	(	int	maxPaletteSize,
		int *	colorsCount
	)		const

inline

Load colors palette from image as a Color array (RGBA - 32bit)

Definition at line 745 of file Image.hpp.

◆ LoadTexture()

::Texture2D raylib::Image::LoadTexture ( ) const

inline

Load texture from image data.

Definition at line 762 of file Image.hpp.

Referenced by operator::Texture2D().

◆ Mipmaps()

Image & raylib::Image::Mipmaps ( )

inline

Generate all mipmap levels for a provided image.

Definition at line 509 of file Image.hpp.

◆ operator::Texture2D()

raylib::Image::operator::Texture2D ( ) const

inline

Loads a texture from the image data.

See also: LoadTexture()

Definition at line 769 of file Image.hpp.

References LoadTexture().

◆ operator=() [1/3]

Image & raylib::Image::operator= ( const ::Image & image )

inline

Definition at line 184 of file Image.hpp.

◆ operator=() [2/3]

Image & raylib::Image::operator= ( const Image & other )

inline

Definition at line 189 of file Image.hpp.

◆ operator=() [3/3]

Image & raylib::Image::operator= ( Image && other )

inlinenoexcept

Definition at line 200 of file Image.hpp.

◆ Resize()

Image & raylib::Image::Resize	(	int	newWidth,
		int	newHeight
	)

inline

Resize and image to new size.

Definition at line 484 of file Image.hpp.

◆ ResizeCanvas()

Image & raylib::Image::ResizeCanvas	(	int	newWidth,
		int	newHeight,
		int	offsetX = `0`,
		int	offsetY = `0`,
		::Color	color = `{255, 255, 255, 255}`
	)

inline

Resize canvas and fill with color.

Definition at line 501 of file Image.hpp.

◆ ResizeNN()

Image & raylib::Image::ResizeNN	(	int	newWidth,
		int	newHeight
	)

inline

Resize and image to new size using Nearest-Neighbor scaling algorithm.

Definition at line 492 of file Image.hpp.

◆ Rotate()

Image & raylib::Image::Rotate ( Degree degrees )

inline

Rotate image by input angle in degrees (-359 to 359)

Note: Only works with integer values, float values will be truncated!

Definition at line 543 of file Image.hpp.

◆ RotateCCW()

Image & raylib::Image::RotateCCW ( )

inline

Rotate image counter-clockwise 90deg.

Definition at line 559 of file Image.hpp.

◆ RotateCW()

Image & raylib::Image::RotateCW ( )

inline

Rotate image clockwise 90deg.

Definition at line 551 of file Image.hpp.

◆ set()

void raylib::Image::set ( const ::Image & image )

inlineprotected

Definition at line 804 of file Image.hpp.

◆ SetHeight()

void raylib::Image::SetHeight	(	int	height,
		int	offsetX = `0`,
		int	offsetY = `0`,
		::Color	fill = `{255, 255, 255, 255}`
	)

inline

Set the height of the image canvas.

See also: ResizeCanvas

Definition at line 383 of file Image.hpp.

◆ SetWidth()

void raylib::Image::SetWidth	(	int	width,
		int	offsetX = `0`,
		int	offsetY = `0`,
		::Color	fill = `{255, 255, 255, 255}`
	)

inline

Set the width of the image canvas.

See also: ResizeCanvas

Definition at line 374 of file Image.hpp.

◆ Text() [1/2]

::Image raylib::Image::Text	(	const ::Font &	font,
		const std::string_view	text,
		float	fontSize,
		float	spacing,
		::Color	tint = `{255, 255, 255, 255}`
	)

inlinestatic

Definition at line 121 of file Image.hpp.

◆ Text() [2/2]

::Image raylib::Image::Text	(	const std::string_view	text,
		int	fontSize,
		::Color	color = `{255, 255, 255, 255}`
	)

inlinestatic

Definition at line 116 of file Image.hpp.

◆ ToPOT()

Image & raylib::Image::ToPOT ( ::Color fillColor )

inline

Convert image to POT (power-of-two)

Definition at line 413 of file Image.hpp.

◆ Unload()

void raylib::Image::Unload ( )

inline

Unload image from CPU memory (RAM)

Definition at line 323 of file Image.hpp.

◆ UnloadColors()

void raylib::Image::UnloadColors ( ::Color * colors ) const

inline

Unload color data loaded with LoadImageColors()

Definition at line 752 of file Image.hpp.

◆ UnloadPalette()

void raylib::Image::UnloadPalette ( ::Color * colors ) const

inline

Unload colors palette loaded with LoadImagePalette()

Definition at line 757 of file Image.hpp.

◆ WhiteNoise()

::Image raylib::Image::WhiteNoise	(	int	width,
		int	height,
		float	factor
	)

inlinestatic

Generate image: white noise.

Definition at line 168 of file Image.hpp.

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Image() [1/13]

◆ Image() [2/13]

◆ Image() [3/13]

◆ Image() [4/13]

◆ Image() [5/13]

◆ Image() [6/13]

◆ Image() [7/13]

◆ Image() [8/13]

◆ Image() [9/13]

◆ Image() [10/13]

◆ Image() [11/13]

◆ Image() [12/13]

◆ Image() [13/13]

◆ ~Image()

Member Function Documentation

◆ AlphaClear()

◆ AlphaCrop()

◆ AlphaMask()

◆ AlphaPremultiply()

◆ Cellular()

◆ Channel()

◆ Checked()

◆ ClearBackground()

◆ Color()

◆ ColorBrightness()

◆ ColorContrast()

◆ ColorGrayscale()

◆ ColorInvert()

◆ ColorReplace()

◆ ColorTint()

◆ Copy()

◆ Crop() [1/4]

◆ Crop() [2/4]

◆ Crop() [3/4]

◆ Crop() [4/4]

◆ Dither()

◆ Draw()

◆ DrawCircle() [1/2]

◆ DrawCircle() [2/2]

◆ DrawLine() [1/3]

◆ DrawLine() [2/3]

◆ DrawLine() [3/3]

◆ DrawPixel() [1/2]

◆ DrawPixel() [2/2]

◆ DrawRectangle() [1/3]

◆ DrawRectangle() [2/3]

◆ DrawRectangle() [3/3]

◆ DrawRectangleLines()

◆ DrawText() [1/6]

◆ DrawText() [2/6]

◆ DrawText() [3/6]

◆ DrawText() [4/6]

◆ DrawText() [5/6]

◆ DrawText() [6/6]

◆ Export()

◆ ExportAsCode()

◆ ExportToMemory() [1/2]

◆ ExportToMemory() [2/2]

◆ FlipHorizontal()

◆ FlipVertical()

◆ Format()

◆ FromImage()

◆ GetAlphaBorder()

◆ GetClipboard()

◆ GetColor() [1/2]

◆ GetColor() [2/2]

◆ GetData()

◆ GetFormat()

◆ GetHeight()

◆ GetMipmaps()

◆ GetPixelDataSize() [1/2]

◆ GetPixelDataSize() [2/2]

◆ GetSize()

◆ GetWidth()

◆ GradientLinear()