Skip to main content

BlpWriter

Struct BlpWriter 

Source
pub struct BlpWriter { /* private fields */ }
Expand description

Writer for BLP texture files

The Writer takes a Texture and encodes it into BLP1 or BLP2 binary format. It supports palettized, JPEG, DXT, and BGRA encodings.

Uses the PImpl (Pointer to Implementation) idiom to hide implementation details.

Implementations§

Source§

impl BlpWriter

Source

pub fn new() -> Self

§Panics

Panics if the native allocation fails.

Source

pub fn write(&mut self, texture: &Texture) -> Bytes

Write a BLP file to a byte buffer with default options

Source

pub fn has_issues(&self) -> bool

Check if writing encountered any issues @return True if there were warnings or recoverable errors

Source

pub fn issues(&self) -> Vec<String>

Get list of issues encountered during writing @return Vector of issue description strings

Trait Implementations§

Source§

impl Debug for BlpWriter

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for BlpWriter

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Drop for BlpWriter

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more
Source§

impl Send for BlpWriter

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.