Struct nvtt_rs::Compressor

pub struct Compressor(_);

The Compressor is used to perform the texture compression.

Methods

impl Compressor

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

Create a new Compressor. If the Compressor cannot be created, returns Error::Unknown.

pub fn into_raw(self) -> *mut NvttCompressor

Returns the underlying NvttCompressor pointer type. It is your responsibility to call nvttDestroyCompressor on this value to clean up the NvttCompressor resources.

pub fn enable_cuda_acceleration<B: Into<NvttBoolean>>(
    &mut self,
    enable: B
) -> &mut Self

If the platform supports the cuda api, this method can be used to enable gpu compression. This may give different results to a pure cpu implementation, so this is set to false by default.

On platforms without cuda, this function is a no-op.

pub fn is_cuda_acceleration_enabled(&self) -> bool

Returns true if cuda acceleration has been enabled. Otherwise, returns false.

pub fn compress(
    &self,
    compress_options: &CompressionOptions,
    input_options: &InputOptions,
    output_options: &OutputOptions
) -> Result<CompressionOutput, Error>

Perform the compression.

pub fn estimate_size(
    &self,
    input_options: &InputOptions,
    compression_options: &CompressionOptions
) -> usize

Estimate the final compressed size of the output texture.

Trait Implementations

impl Drop for Compressor

fn drop(&mut self)

Executes the destructor for this type.

impl Debug for Compressor

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

Formats the value using the given formatter.