Struct Context 

pub struct Context { /* private fields */ }

The core context. All configuration should be done through this.

Implementations

impl Context

pub fn with_threads(threads: usize, config: Config) -> Result<Self, Error>

Create a new context from the given config (see ConfigBuilder for more information on this config), and sets the number of threads that the internal encoder/decoder will use. See Context::new, which does the same thing but automatically guesses the correct thread count by trying to use 8 threads but falling back to the number of cores if it is less than 8. Returns an error in the case that the config is invalid or the context could not be allocated.

pub fn new(config: Config) -> Result<Self, Error>

Create a new context from the given config (see ConfigBuilder for more information on this config). Returns an error in the case that the config is invalid or the context could not be allocated.

pub fn compress<D, T, L>( &mut self, image: &Image<T>, swizzle: Swizzle, ) -> Result<Vec<u8>, Error>

where D: DataType, T: Deref<Target = [L]>, L: Deref<Target = [D]>,

Compress the given image, returning a byte vector that can be sent to the GPU.

pub fn decompress_into<D, T, L>( &mut self, data: &[u8], out: &mut Image<T>, swizzle: Swizzle, ) -> Result<(), Error>

where D: DataType, T: DerefMut<Target = [L]>, L: DerefMut<Target = [D]>,

Decompress an image into a pre-existing buffer. The metadata (size and border padding) must already be set and enough space must be reserved in out.data for the output pixels (RGBA).

pub fn decompress<D>( &mut self, data: &[u8], extents: Extents, swizzle: Swizzle, ) -> Result<Image<Vec<Vec<D>>>, Error>

where D: DataType,

Decompress an image. The metadata is not stored in the compressed data itself, and should be stored as a separate header.

Trait Implementations

impl Default for Context

fn default() -> Self

Returns the “default value” for a type.

impl Drop for Context

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Context

impl Sync for Context