SourcePP
Several modern C++20 libraries for sanely parsing Valve's formats.
Loading...
Searching...
No Matches
Functions
vtfpp::ImageFormatDetails Namespace Reference

Functions

constexpr int8_t red (ImageFormat format)
 
constexpr int8_t decompressedRed (ImageFormat format)
 
constexpr int8_t green (ImageFormat format)
 
constexpr int8_t decompressedGreen (ImageFormat format)
 
constexpr int8_t blue (ImageFormat format)
 
constexpr int8_t decompressedBlue (ImageFormat format)
 
constexpr int8_t alpha (ImageFormat format)
 
constexpr int8_t decompressedAlpha (ImageFormat format)
 
constexpr uint8_t bpp (ImageFormat format)
 
constexpr ImageFormat containerFormat (ImageFormat format)
 
constexpr bool large (ImageFormat format)
 
constexpr bool decimal (ImageFormat format)
 
constexpr bool compressed (ImageFormat format)
 
constexpr bool transparent (ImageFormat format)
 
constexpr bool opaque (ImageFormat format)
 
constexpr bool console (ImageFormat format)
 
constexpr uint32_t getDataLength (ImageFormat format, uint16_t width, uint16_t height, uint16_t depth=1)
 
constexpr uint32_t getDataLength (ImageFormat format, uint8_t mipCount, uint16_t frameCount, uint8_t faceCount, uint16_t width, uint16_t height, uint16_t depth=1)
 
constexpr uint32_t getDataLengthXBOX (bool padded, ImageFormat format, uint8_t mipCount, uint16_t frameCount, uint8_t faceCount, uint16_t width, uint16_t height, uint16_t depth=1)
 
constexpr bool getDataPosition (uint32_t &offset, uint32_t &length, ImageFormat format, uint8_t mip, uint8_t mipCount, uint16_t frame, uint16_t frameCount, uint8_t face, uint8_t faceCount, uint16_t width, uint16_t height, uint16_t slice=0, uint16_t depth=1)
 
constexpr bool getDataPositionXbox (uint32_t &offset, uint32_t &length, bool padded, ImageFormat format, uint8_t mip, uint8_t mipCount, uint16_t frame, uint16_t frameCount, uint8_t face, uint8_t faceCount, uint16_t width, uint16_t height, uint16_t slice=0, uint16_t depth=1)
 

Function Documentation

◆ alpha()

constexpr int8_t vtfpp::ImageFormatDetails::alpha ( ImageFormat  format)
constexpr

Definition at line 345 of file ImageFormats.h.

◆ blue()

constexpr int8_t vtfpp::ImageFormatDetails::blue ( ImageFormat  format)
constexpr

Definition at line 256 of file ImageFormats.h.

◆ bpp()

constexpr uint8_t vtfpp::ImageFormatDetails::bpp ( ImageFormat  format)
constexpr

Definition at line 436 of file ImageFormats.h.

◆ compressed()

constexpr bool vtfpp::ImageFormatDetails::compressed ( ImageFormat  format)
constexpr

Definition at line 579 of file ImageFormats.h.

◆ console()

constexpr bool vtfpp::ImageFormatDetails::console ( ImageFormat  format)
constexpr

Definition at line 624 of file ImageFormats.h.

◆ containerFormat()

constexpr ImageFormat vtfpp::ImageFormatDetails::containerFormat ( ImageFormat  format)
constexpr

Definition at line 506 of file ImageFormats.h.

◆ decimal()

constexpr bool vtfpp::ImageFormatDetails::decimal ( ImageFormat  format)
constexpr

Definition at line 575 of file ImageFormats.h.

◆ decompressedAlpha()

constexpr int8_t vtfpp::ImageFormatDetails::decompressedAlpha ( ImageFormat  format)
constexpr

Definition at line 414 of file ImageFormats.h.

◆ decompressedBlue()

constexpr int8_t vtfpp::ImageFormatDetails::decompressedBlue ( ImageFormat  format)
constexpr

Definition at line 325 of file ImageFormats.h.

◆ decompressedGreen()

constexpr int8_t vtfpp::ImageFormatDetails::decompressedGreen ( ImageFormat  format)
constexpr

Definition at line 236 of file ImageFormats.h.

◆ decompressedRed()

constexpr int8_t vtfpp::ImageFormatDetails::decompressedRed ( ImageFormat  format)
constexpr

Definition at line 146 of file ImageFormats.h.

◆ getDataLength() [1/2]

constexpr uint32_t vtfpp::ImageFormatDetails::getDataLength ( ImageFormat  format,
uint16_t  width,
uint16_t  height,
uint16_t  depth = 1 
)
constexpr

Definition at line 715 of file ImageFormats.h.

◆ getDataLength() [2/2]

constexpr uint32_t vtfpp::ImageFormatDetails::getDataLength ( ImageFormat  format,
uint8_t  mipCount,
uint16_t  frameCount,
uint8_t  faceCount,
uint16_t  width,
uint16_t  height,
uint16_t  depth = 1 
)
constexpr

Definition at line 733 of file ImageFormats.h.

◆ getDataLengthXBOX()

constexpr uint32_t vtfpp::ImageFormatDetails::getDataLengthXBOX ( bool  padded,
ImageFormat  format,
uint8_t  mipCount,
uint16_t  frameCount,
uint8_t  faceCount,
uint16_t  width,
uint16_t  height,
uint16_t  depth = 1 
)
constexpr

Definition at line 742 of file ImageFormats.h.

◆ getDataPosition()

constexpr bool vtfpp::ImageFormatDetails::getDataPosition ( uint32_t &  offset,
uint32_t &  length,
ImageFormat  format,
uint8_t  mip,
uint8_t  mipCount,
uint16_t  frame,
uint16_t  frameCount,
uint8_t  face,
uint8_t  faceCount,
uint16_t  width,
uint16_t  height,
uint16_t  slice = 0,
uint16_t  depth = 1 
)
constexpr

Definition at line 755 of file ImageFormats.h.

◆ getDataPositionXbox()

constexpr bool vtfpp::ImageFormatDetails::getDataPositionXbox ( uint32_t &  offset,
uint32_t &  length,
bool  padded,
ImageFormat  format,
uint8_t  mip,
uint8_t  mipCount,
uint16_t  frame,
uint16_t  frameCount,
uint8_t  face,
uint8_t  faceCount,
uint16_t  width,
uint16_t  height,
uint16_t  slice = 0,
uint16_t  depth = 1 
)
constexpr

Definition at line 776 of file ImageFormats.h.

◆ green()

constexpr int8_t vtfpp::ImageFormatDetails::green ( ImageFormat  format)
constexpr

Definition at line 166 of file ImageFormats.h.

◆ large()

constexpr bool vtfpp::ImageFormatDetails::large ( ImageFormat  format)
constexpr

Definition at line 571 of file ImageFormats.h.

◆ opaque()

constexpr bool vtfpp::ImageFormatDetails::opaque ( ImageFormat  format)
constexpr

Definition at line 620 of file ImageFormats.h.

◆ red()

constexpr int8_t vtfpp::ImageFormatDetails::red ( ImageFormat  format)
constexpr

Definition at line 77 of file ImageFormats.h.

◆ transparent()

constexpr bool vtfpp::ImageFormatDetails::transparent ( ImageFormat  format)
constexpr

Definition at line 583 of file ImageFormats.h.