Enumerations
enum class	FileFormat { DEFAULT = 0 , PNG = 1 , JPG = 2 , BMP = 3 , TGA = 4 , HDR = 7 }
enum class	ResizeEdge { CLAMP = 0 , REFLECT , WRAP , ZERO }
enum class	ResizeFilter { DEFAULT = 0 , BOX , BILINEAR , CUBIC_BSPLINE , CATMULL_ROM , MITCHELL , POINT_SAMPLE , KAISER = 100 , NICE = 101 }
enum class	ResizeMethod { NONE , POWER_OF_TWO_BIGGER , POWER_OF_TWO_SMALLER , POWER_OF_TWO_NEAREST }

Functions
std::vector< std::byte >	convertImageDataToFormat (std::span< const std::byte > imageData, ImageFormat oldFormat, ImageFormat newFormat, uint16_t width, uint16_t height, float quality=DEFAULT_COMPRESSED_QUALITY)
	Converts an image from one format to another.
std::vector< std::byte >	convertSeveralImageDataToFormat (std::span< const std::byte > imageData, ImageFormat oldFormat, ImageFormat newFormat, uint8_t mipCount, uint16_t frameCount, uint8_t faceCount, uint16_t width, uint16_t height, uint16_t depth, float quality=DEFAULT_COMPRESSED_QUALITY)
	Converts several images from one format to another.
std::array< std::vector< std::byte >, 6 >	convertHDRIToCubeMap (std::span< const std::byte > imageData, ImageFormat format, uint16_t width, uint16_t height, uint16_t resolution=0, bool bilinear=true)
	Converts an HDRI into a cubemap.
FileFormat	getDefaultFileFormatForImageFormat (ImageFormat format)
	PNG for integer formats, EXR for floating point formats.
std::vector< std::byte >	convertImageDataToFile (std::span< const std::byte > imageData, ImageFormat format, uint16_t width, uint16_t height, FileFormat fileFormat=FileFormat::DEFAULT)
	Converts image data to the given file format (PNG or EXR by default).
std::vector< std::byte >	convertFileToImageData (std::span< const std::byte > fileData, ImageFormat &format, int &width, int &height, int &frameCount)
uint16_t	getResizedDim (uint16_t n, ResizeMethod method)
	Get the new image size given a resize method.
void	setResizedDims (uint16_t &width, ResizeMethod widthResize, uint16_t &height, ResizeMethod heightResize)
	Set the new image dimensions given a resize method.
std::vector< std::byte >	resizeImageData (std::span< const std::byte > imageData, ImageFormat format, uint16_t width, uint16_t newWidth, uint16_t height, uint16_t newHeight, bool srgb, ResizeFilter filter, ResizeEdge edge=ResizeEdge::CLAMP)
	Resize given image data to the new dimensions.
std::vector< std::byte >	resizeImageDataStrict (std::span< const std::byte > imageData, ImageFormat format, uint16_t width, uint16_t newWidth, uint16_t &widthOut, ResizeMethod widthResize, uint16_t height, uint16_t newHeight, uint16_t &heightOut, ResizeMethod heightResize, bool srgb, ResizeFilter filter, ResizeEdge edge=ResizeEdge::CLAMP)
	Resize given image data to the new dimensions, where the new width and height are governed by the resize methods.
std::vector< std::byte >	cropImageData (std::span< const std::byte > imageData, ImageFormat format, uint16_t width, uint16_t newWidth, uint16_t xOffset, uint16_t height, uint16_t newHeight, uint16_t yOffset)
	Crops the given image to the new dimensions. If the image format is compressed it will be converted to its container format before the crop, and converted back before returning.
std::vector< std::byte >	padImageData (std::span< const std::byte > imageData, ImageFormat format, uint16_t width, uint16_t widthPad, uint16_t height, uint16_t heightPad)
	Pad the given image with pixels that are the same color as the edge. Padding is applied to the right and bottom of the image.
std::vector< std::byte >	gammaCorrectImageData (std::span< const std::byte > imageData, ImageFormat format, uint16_t width, uint16_t height, float gamma)
	Perform gamma correction on the given image data. Will not perform gamma correction if the input image format is large, console, P8, A8, UV88, UVLX8888, or UVWQ8888.
std::vector< std::byte >	invertGreenChannelForImageData (std::span< const std::byte > imageData, ImageFormat format, uint16_t width, uint16_t height)
	Invert the green channel. Meant for converting normal maps between OpenGL and DirectX formats.
template<ImagePixel::PixelType P>
std::vector< std::byte >	extractChannelFromImageData (std::span< const std::byte > imageData, auto P::*channel)
	Extracts a single channel from the given image data.

Variables
constexpr float	DEFAULT_COMPRESSED_QUALITY = -1.f

Enumeration Type Documentation

◆ FileFormat

enum class vtfpp::ImageConversion::FileFormat

strong

Enumerator
DEFAULT
PNG
JPG
BMP
TGA
HDR

Definition at line 344 of file ImageConversion.h.

◆ ResizeEdge

enum class vtfpp::ImageConversion::ResizeEdge

strong

Enumerator
CLAMP
REFLECT
WRAP
ZERO

Definition at line 370 of file ImageConversion.h.

◆ ResizeFilter

enum class vtfpp::ImageConversion::ResizeFilter

strong

Enumerator
DEFAULT
BOX
BILINEAR
CUBIC_BSPLINE
CATMULL_ROM
MITCHELL
POINT_SAMPLE
KAISER
NICE	Valve NICE filtering, equivalent to Lanczos-3.

Definition at line 378 of file ImageConversion.h.

◆ ResizeMethod

enum class vtfpp::ImageConversion::ResizeMethod

strong

Enumerator
NONE
POWER_OF_TWO_BIGGER
POWER_OF_TWO_SMALLER
POWER_OF_TWO_NEAREST

Definition at line 394 of file ImageConversion.h.

Function Documentation

◆ convertFileToImageData()

std::vector< std::byte > vtfpp::ImageConversion::convertFileToImageData	(	std::span< const std::byte >	fileData,
		ImageFormat &	format,
		int &	width,
		int &	height,
		int &	frameCount )

nodiscard

Definition at line 1428 of file ImageConversion.cpp.

◆ convertHDRIToCubeMap()

std::array< std::vector< std::byte >, 6 > vtfpp::ImageConversion::convertHDRIToCubeMap	(	std::span< const std::byte >	imageData,
		ImageFormat	format,
		uint16_t	width,
		uint16_t	height,
		uint16_t	resolution = 0,
		bool	bilinear = true )

nodiscard

Converts an HDRI into a cubemap.

The output image data is in the same image format as the input. The output images have the following order: front, back, left, right, down, up. Resolution is the output size (width, height) of each image slice. 0 leaves it at the input size, the height of the HDRI. Fails (returns empty vectors) if the input data is empty, the given width is not 2x the height, or an error was encountered.

Definition at line 1001 of file ImageConversion.cpp.

◆ convertImageDataToFile()

std::vector< std::byte > vtfpp::ImageConversion::convertImageDataToFile	(	std::span< const std::byte >	imageData,
		ImageFormat	format,
		uint16_t	width,
		uint16_t	height,
		FileFormat	fileFormat = FileFormat::DEFAULT )

nodiscard

Converts image data to the given file format (PNG or EXR by default).

Definition at line 1133 of file ImageConversion.cpp.

◆ convertImageDataToFormat()

std::vector< std::byte > vtfpp::ImageConversion::convertImageDataToFormat	(	std::span< const std::byte >	imageData,
		ImageFormat	oldFormat,
		ImageFormat	newFormat,
		uint16_t	width,
		uint16_t	height,
		float	quality = DEFAULT_COMPRESSED_QUALITY )

nodiscard

Converts an image from one format to another.

Definition at line 897 of file ImageConversion.cpp.

◆ convertSeveralImageDataToFormat()

std::vector< std::byte > vtfpp::ImageConversion::convertSeveralImageDataToFormat	(	std::span< const std::byte >	imageData,
		ImageFormat	oldFormat,
		ImageFormat	newFormat,
		uint8_t	mipCount,
		uint16_t	frameCount,
		uint8_t	faceCount,
		uint16_t	width,
		uint16_t	height,
		uint16_t	depth,
		float	quality = DEFAULT_COMPRESSED_QUALITY )

nodiscard

Converts several images from one format to another.

Definition at line 973 of file ImageConversion.cpp.

◆ cropImageData()

std::vector< std::byte > vtfpp::ImageConversion::cropImageData	(	std::span< const std::byte >	imageData,
		ImageFormat	format,
		uint16_t	width,
		uint16_t	newWidth,
		uint16_t	xOffset,
		uint16_t	height,
		uint16_t	newHeight,
		uint16_t	yOffset )

nodiscard

Crops the given image to the new dimensions. If the image format is compressed it will be converted to its container format before the crop, and converted back before returning.

Definition at line 2065 of file ImageConversion.cpp.

◆ extractChannelFromImageData()

template<ImagePixel::PixelType P>

std::vector< std::byte > vtfpp::ImageConversion::extractChannelFromImageData	(	std::span< const std::byte >	imageData,
		auto P::*	channel )

nodiscard

Extracts a single channel from the given image data.

May have unexpected behavior if called on formats that use bitfields like BGRA5551! Data is packed according to pixel channel C++ type size (e.g. in the case of BGRA5551's green channel, it'll be 2 bytes per green value despite only 5 bits being used in the original data)

Definition at line 430 of file ImageConversion.h.

◆ gammaCorrectImageData()

std::vector< std::byte > vtfpp::ImageConversion::gammaCorrectImageData	(	std::span< const std::byte >	imageData,
		ImageFormat	format,
		uint16_t	width,
		uint16_t	height,
		float	gamma )

nodiscard

Perform gamma correction on the given image data. Will not perform gamma correction if the input image format is large, console, P8, A8, UV88, UVLX8888, or UVWQ8888.

Definition at line 2121 of file ImageConversion.cpp.

◆ getDefaultFileFormatForImageFormat()

ImageConversion::FileFormat vtfpp::ImageConversion::getDefaultFileFormatForImageFormat ( ImageFormat format )

nodiscard

PNG for integer formats, EXR for floating point formats.

Definition at line 1124 of file ImageConversion.cpp.

◆ getResizedDim()

uint16_t vtfpp::ImageConversion::getResizedDim	(	uint16_t	n,
		ResizeMethod	method )

nodiscard

Get the new image size given a resize method.

Definition at line 1957 of file ImageConversion.cpp.

◆ invertGreenChannelForImageData()

std::vector< std::byte > vtfpp::ImageConversion::invertGreenChannelForImageData	(	std::span< const std::byte >	imageData,
		ImageFormat	format,
		uint16_t	width,
		uint16_t	height )

nodiscard

Invert the green channel. Meant for converting normal maps between OpenGL and DirectX formats.

Definition at line 2227 of file ImageConversion.cpp.

◆ padImageData()

std::vector< std::byte > vtfpp::ImageConversion::padImageData	(	std::span< const std::byte >	imageData,
		ImageFormat	format,
		uint16_t	width,
		uint16_t	widthPad,
		uint16_t	height,
		uint16_t	heightPad )

nodiscard

Pad the given image with pixels that are the same color as the edge. Padding is applied to the right and bottom of the image.

Definition at line 2084 of file ImageConversion.cpp.

◆ resizeImageData()

std::vector< std::byte > vtfpp::ImageConversion::resizeImageData	(	std::span< const std::byte >	imageData,
		ImageFormat	format,
		uint16_t	width,
		uint16_t	newWidth,
		uint16_t	height,
		uint16_t	newHeight,
		bool	srgb,
		ResizeFilter	filter,
		ResizeEdge	edge = ResizeEdge::CLAMP )

nodiscard

Resize given image data to the new dimensions.

Definition at line 1972 of file ImageConversion.cpp.

◆ resizeImageDataStrict()

std::vector< std::byte > vtfpp::ImageConversion::resizeImageDataStrict	(	std::span< const std::byte >	imageData,
		ImageFormat	format,
		uint16_t	width,
		uint16_t	newWidth,
		uint16_t &	widthOut,
		ResizeMethod	widthResize,
		uint16_t	height,
		uint16_t	newHeight,
		uint16_t &	heightOut,
		ResizeMethod	heightResize,
		bool	srgb,
		ResizeFilter	filter,
		ResizeEdge	edge = ResizeEdge::CLAMP )

nodiscard

Resize given image data to the new dimensions, where the new width and height are governed by the resize methods.

Definition at line 2055 of file ImageConversion.cpp.

◆ setResizedDims()

void vtfpp::ImageConversion::setResizedDims	(	uint16_t &	width,
		ResizeMethod	widthResize,
		uint16_t &	height,
		ResizeMethod	heightResize )

Set the new image dimensions given a resize method.

Definition at line 1967 of file ImageConversion.cpp.

Variable Documentation

◆ DEFAULT_COMPRESSED_QUALITY

float vtfpp::ImageConversion::DEFAULT_COMPRESSED_QUALITY = -1.f

constexpr

Definition at line 330 of file ImageConversion.h.

Enumerations

Functions

Variables

Enumeration Type Documentation

◆ FileFormat

◆ ResizeEdge

◆ ResizeFilter

◆ ResizeMethod

Function Documentation

◆ convertFileToImageData()

◆ convertHDRIToCubeMap()

◆ convertImageDataToFile()

◆ convertImageDataToFormat()

◆ convertSeveralImageDataToFormat()

◆ cropImageData()

◆ extractChannelFromImageData()

◆ gammaCorrectImageData()

◆ getDefaultFileFormatForImageFormat()

◆ getResizedDim()

◆ invertGreenChannelForImageData()

◆ padImageData()

◆ resizeImageData()

◆ resizeImageDataStrict()

◆ setResizedDims()

Variable Documentation

◆ DEFAULT_COMPRESSED_QUALITY