Struct nvtt_rs::InputOptions

pub struct InputOptions(_);

Object which stores the input options for the texture. This provides a safer interface for the NvttInputOptions type.

Implementations

impl InputOptions

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

Create a new InputOptions.

pub fn into_raw(self) -> *mut NvttInputOptions

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

pub fn set_alpha_mode(&mut self, alpha_mode: AlphaMode) -> &mut Self

Set the AlphaMode on the InputOptions.

pub fn convert_to_normal_map(
    &mut self,
    convert_to_normal_map: impl Into<NvttBoolean>
) -> &mut Self

If this parameter is set, then nvtt will convert the image into a normal map.

pub fn set_format(&mut self, format: InputFormat) -> &mut Self

Sets the InputFormat of the input data. This tells nvtt which pixel format it should interpret the byte data passed in InputOptions::set_mipmap_data as.

pub fn set_gamma(&mut self, input_gamma: f32, output_gamma: f32) -> &mut Self

Set the input_gamma and output_gamma on the InputOptions.

pub fn set_height_evaluation(
    &mut self,
    red_scale: f32,
    green_scale: f32,
    blue_scale: f32,
    alpha_scale: f32
) -> &mut Self

pub fn set_mipmap_filter(&mut self, mipmap_filter: MipmapFilter) -> &mut Self

Set the MipmapFilter on the InputOptions. See the MipmapFilter type for more info.

pub fn set_mipmap_data(
    &mut self,
    data: &[u8],
    w: i32,
    h: i32,
    d: i32,
    face: i32,
    mipmap: i32
) -> Result<&mut Self, Error>

Sets the input data which should be compressed.

The data is copied into the InputOptions object.

Errors

If the dimensions of the image do not match the length of the data, then this method will fail with Error::Unknown.

pub fn reset(&mut self) -> &mut Self

Resets the InputOptions back to the default state.

pub fn set_image<'a, I: Into<ValidImage<'a>>>(
    &mut self,
    image: I,
    face: i32,
    mipmap: i32
) -> Result<&mut Self, Error>

Sets the input texture data to the data contained by image.

Notes

• This method requires the nvtt_image_integration feature.
• This method clears any previous state set on the InputOptions.

pub fn set_max_extents(&mut self, max_extents: c_int) -> &mut Self

Constrain the texture size to the value in max_extents.

pub fn set_normal_map(
    &mut self,
    is_normal_map: impl Into<NvttBoolean>
) -> &mut Self

Specify whether the image is a normal map. Normal maps may be compressed differently to better preserve the normal information.

pub fn set_normalize_mipmaps(
    &mut self,
    normalize_mips: impl Into<NvttBoolean>
) -> &mut Self

pub fn set_normal_filter(&mut self, filter: NormalMapFilter) -> &mut Self

Set the NormalMapFilter params on the InputOptions.

pub fn set_round_mode(&mut self, round_mode: RoundMode) -> &mut Self

Set the RoundMode on the InputOptions.

pub fn set_texture_layout(&mut self, texture_layout: TextureLayout) -> &mut Self

Sets the layout of the texture on the InputOptions.

pub fn set_wrap_mode(&mut self, wrap_mode: WrapMode) -> &mut Self

Set the WrapMode on the InputOptions.

Trait Implementations

impl Debug for InputOptions

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

Formats the value using the given formatter.

impl Drop for InputOptions

fn drop(&mut self)

Executes the destructor for this type.

impl Send for InputOptions

impl Sync for InputOptions