wowlib::formats::blp::EncodeSettings Struct Reference

#include <wowlib/formats/blp/blp.hpp>

Public Member Functions
bool	operator== (const EncodeSettings &) const =default

Public Attributes
ColorEncoding	encoding = ColorEncoding::Dxt
	The payload encoding to produce (Palettized, Dxt or Bgra; Jpeg is not supported).
PixelFormat	format = PixelFormat::Unspecified
	The DXT block format for Dxt encoding (Dxt1, Dxt3, Dxt5 or Bc5).
std::uint8_t	alphaDepth = 8
	Alpha bits per pixel: 0, 1, 4 or 8.
bool	mipmaps = true
	Whether to generate the full mip chain down to 1x1 (box-filtered).

Detailed Description

Definition at line 142 of file blp.hpp.

Member Function Documentation

operator==()

bool wowlib::formats::blp::EncodeSettings::operator== ( const EncodeSettings & ) const

default

Member Data Documentation

alphaDepth

std::uint8_t wowlib::formats::blp::EncodeSettings::alphaDepth = 8

Alpha bits per pixel: 0, 1, 4 or 8.

Selects the alpha plane depth for Palettized files and the block format for Dxt when format is Unspecified.

Definition at line 150 of file blp.hpp.

Referenced by wowlib::formats::blp::BLP::encode().

encoding

ColorEncoding wowlib::formats::blp::EncodeSettings::encoding = ColorEncoding::Dxt

The payload encoding to produce (Palettized, Dxt or Bgra; Jpeg is not supported).

Definition at line 144 of file blp.hpp.

Referenced by wowlib::formats::blp::BLP::encode().

format

PixelFormat wowlib::formats::blp::EncodeSettings::format = PixelFormat::Unspecified

The DXT block format for Dxt encoding (Dxt1, Dxt3, Dxt5 or Bc5).

Unspecified picks from alphaDepth: 0/1 -> Dxt1, 4 -> Dxt3, 8 -> Dxt5. Ignored for Palettized/Bgra.

Definition at line 147 of file blp.hpp.

Referenced by wowlib::formats::blp::BLP::encode().

mipmaps

bool wowlib::formats::blp::EncodeSettings::mipmaps = true

Whether to generate the full mip chain down to 1x1 (box-filtered).

Off: the file holds only level 0.

Definition at line 153 of file blp.hpp.

Referenced by wowlib::formats::blp::BLP::encode().

---

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

• src/wowlib/formats/blp/blp.hpp