Util::Image Class Reference

A class representing an image. More...

#include <Image.hpp>

Inheritance diagram for Util::Image:

Public Member Functions
	Image (const std::string &filepath)
	Constructor that takes a file path to the image.
glm::vec2	GetSize () const override
	Retrieves the size of the image.
void	SetImage (const std::string &filepath)
	Sets the image to the specified file path.
void	Draw (const Core::Matrices &data) override
	Draws the image with a given transform and z-index.

Detailed Description

A class representing an image.

This class encapsulates the properties and behaviors of an image. It includes properties such as texture and surface. It also includes behaviors such as drawing the image.

Constructor & Destructor Documentation

Image()

Util::Image::Image ( const std::string & filepath )

explicit

Constructor that takes a file path to the image.

Parameters

filepath

The file path to the image.

Member Function Documentation

Draw()

void Util::Image::Draw ( const Core::Matrices & data )

overridevirtual

Draws the image with a given transform and z-index.

This function draws the image at the specified z-index and applies the given transform.

Parameters

transform	The transform to apply to the image.
zIndex	The z-index at which to draw the image.

Implements Core::Drawable.

GetSize()

glm::vec2 Util::Image::GetSize ( ) const

inlineoverridevirtual

Retrieves the size of the image.

This function returns the size of the image.

Returns

The size of the image as a vec2(x, y).

Implements Core::Drawable.

SetImage()

void Util::Image::SetImage

(

const std::string &

filepath

)

Sets the image to the specified file path.

This function sets the image to the specified file path.

Parameters

filepath

The file path to the image.

---

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

• include/Util/Image.hpp