smk::Texture Struct Reference

#include <Texture.hpp>

Description

A texture loaded from a file into the GPU. This class support the move and copy operators. Its underlying GPU texture is refcounted and released when then last smk::Texture is deleted.

Example:

auto texture = smk::Texture("./ball.png");

Supported image encoding:

The SMK library uses the stb_image. So it supports the same image types:

• JPEG baseline & progressive (12 bpc/arithmetic not supported, same as stock IJG lib)
• PNG 1/2/4/8/16-bit-per-channel
• TGA
• BMP non-1bpp, non-RLE
• PSD (composited view only, no extra channels, 8/16 bit-per-channel)
• GIF
• HDR (radiance rgbE format)
• PIC (Softimage PIC)
• PNM (PPM and PGM binary only)

Examples

shape_3d.cpp, sprite.cpp, sprite_move.cpp, and texture_subrectangle.cpp.

Definition at line 38 of file Texture.hpp.

Classes
struct	Option

Public Member Functions
	Texture ()
	The null texture. More...
	Texture (const std::string &filename)
	Load a texture from a file. More...
	Texture (const std::string &filename, const Option &option)
	Load a texture from a file. More...
	Texture (const uint8_t *data, int width, int height)
	Load a texture from memory (RAM) More...
	Texture (const uint8_t *data, int width, int height, const Option &option)
	Load a texture from memory (RAM) More...
	Texture (GLuint id, int width, int height)
	Import an already loaded texture. Useful. More...
void	Bind (GLuint active_texture=GL_TEXTURE0) const
int	width () const
	Access the width of the texture. More...
int	height () const
	Access the height of the texture. More...
GLuint	id () const
	Access the ID of the texture. More...
	operator bool () const
	Texture (Texture &&) noexcept
	Texture (const Texture &)
Texture &	operator= (Texture &&) noexcept
Texture &	operator= (const Texture &)
bool	operator== (const Texture &other) const
bool	operator!= (const Texture &other) const

---

Class Documentation

smk::Texture::Option

struct smk::Texture::Option

Definition at line 40 of file Texture.hpp.

Class Members
GLint	format
bool	generate_mipmap
GLint	internal_format
GLint	mag_filter
GLint	min_filter
GLint	type
GLint	wrap_s
GLint	wrap_t

Constructor & Destructor Documentation

Texture() [1/8]

smk::Texture::Texture ( )

default

The null texture.

Texture() [2/8]

smk::Texture::Texture

(

const std::string &

filename

)

Load a texture from a file.

Parameters

filename

The file name of the image to be loaded

Definition at line 30 of file Texture.cpp.

: Texture(filename, Option()) {}

Texture() [3/8]

smk::Texture::Texture	(	const std::string &	filename,
		const Option &	option
	)

Load a texture from a file.

Parameters

filename	The file name of the image to be loaded.
option	Additionnal option (texture wrap, min filter, mag filter, ...)

Definition at line 35 of file Texture.cpp.

                                                                {
  FILE* file = fopen(filename.c_str(), "rb"); // NOLINT
  if (!file) {
    std::cerr << "File " << filename << " not found" << std::endl;
    fclose(file); // NOLINT
    return;
  }
 
  int comp = -1;
  unsigned char* data = stbi_load_from_file(file, &width_, &height_, &comp, 0);
  fclose(file); // NOLINT
 
  // Canonicalize the image to RGBA(8,8,8,8) and maybe on power_of_2 texture.
  int width_b = next_power_of_2(width_);
  int height_b = next_power_of_2(height_);
  std::vector<uint8_t> transformed(width_b * height_b * 4, 0);
  for (int y = 0; y < height_; ++y) {
    for (int x = 0; x < width_; ++x) {
      for (int c = 0; c < 4; ++c) {
        // NOLINTNEXTLINE
        transformed[c + 4 * (x + width_b * y)] =
            // NOLINTNEXTLINE
            (c == 3 && comp != 4) ? 255 : data[c + comp * (x + width_ * y)];
      }
    }
  }
  Load(transformed.data(), width_b, height_b, option);
  stbi_image_free(data);
}

Texture() [4/8]

smk::Texture::Texture	(	const uint8_t *	data,
		int	width,
		int	height
	)

Load a texture from memory (RAM)

Parameters

data	The memory area to read the image from.
width	the image's with.
height	the image's height.

Definition at line 69 of file Texture.cpp.

    : Texture(data, width, height, Option()) {}

Texture() [5/8]

smk::Texture::Texture	(	const uint8_t *	data,
		int	width,
		int	height,
		const Option &	option
	)

Load a texture from memory (RAM)

Parameters

data	The memory area to read the image from.
width	the image's with.
height	the image's height.
option	Additionnal option (texture wrap, min filter, mag filter, ...)

Definition at line 77 of file Texture.cpp.

    : Texture() {
  width_ = width;
  height_ = height;
  Load(data, width_, height_, option);
}

Texture() [6/8]

smk::Texture::Texture	(	GLuint	id,
		int	width,
		int	height
	)

Import an already loaded texture. Useful.

Parameters

id	The OpenGL identifier of the loaded texture.
width	the image's with.
height	the image's height.

Definition at line 110 of file Texture.cpp.

    : id_(id), width_(width), height_(height) {}

~Texture()

smk::Texture::~Texture

(

)

Definition at line 115 of file Texture.cpp.

                  {
  Release();
}

Texture() [7/8]

smk::Texture::Texture ( Texture &&  other )

noexcept

Definition at line 141 of file Texture.cpp.

                                         {
  operator=(std::move(other));
}

Texture() [8/8]

smk::Texture::Texture

(

const Texture &

other

)

Definition at line 145 of file Texture.cpp.

                                     {
  operator=(other);
}

Member Function Documentation

Bind()

void smk::Texture::Bind

(

GLuint

active_texture = GL_TEXTURE0

)

const

Definition at line 180 of file Texture.cpp.

                                              { 
  glActiveTexture(active_texture); 
  glBindTexture(GL_TEXTURE_2D, id_);
}

height()

int smk::Texture::height

(

)

const

Access the height of the texture.

Returns

The texture's height in pixel

Definition at line 201 of file Texture.cpp.

                          {
  return height_;
}

id()

GLuint smk::Texture::id

(

)

const

Access the ID of the texture.

Returns

The texture's ID.

Definition at line 207 of file Texture.cpp.

                         {
  return id_;
}

operator bool()

smk::Texture::operator bool ( ) const

inline

Definition at line 65 of file Texture.hpp.

{ return id_ != 0; }

operator!=()

bool smk::Texture::operator!=

(

const Texture &

other

)

const

Definition at line 189 of file Texture.cpp.

                                                   {
  return id_ != other.id_;
}

operator=() [1/2]

Texture & smk::Texture::operator=

(

const Texture &

other

)

Definition at line 158 of file Texture.cpp.

                                                {
  if (&other == this) {
    return *this;
  }
  Release();
  id_ = other.id_;
  width_ = other.width_;
  height_ = other.height_;
 
  if (!other.id_) {
    return *this;
  }
 
  if (!other.ref_count_) {
    other.ref_count_ = new int(1); // NOLINT
  }
 
  ref_count_ = other.ref_count_;
  (*ref_count_)++;
  return *this;
}

operator=() [2/2]

Texture & smk::Texture::operator= ( Texture &&  other )

noexcept

Definition at line 149 of file Texture.cpp.

                                                    {
  Release();
  std::swap(id_, other.id_);
  std::swap(width_, other.width_);
  std::swap(height_, other.height_);
  std::swap(ref_count_, other.ref_count_);
  return *this;
}

operator==()

bool smk::Texture::operator==

(

const Texture &

other

)

const

Definition at line 185 of file Texture.cpp.

                                                   {
  return id_ == other.id_;
}

width()

int smk::Texture::width

(

)

const

Access the width of the texture.

Returns

The texture's width in pixel

Examples

sprite_move.cpp.

Definition at line 195 of file Texture.cpp.

                         {
  return width_;
}

---

The documentation for this struct was generated from the following files:

• /home/arthursonzogni/programmation/real/smk/include/smk/Texture.hpp
• /home/arthursonzogni/programmation/real/smk/src/smk/Texture.cpp