Skip to content

Commit

Permalink
document mip_chunk read options
Browse files Browse the repository at this point in the history
  • Loading branch information
Ryan-rsm-McKenzie committed Jan 2, 2025
1 parent b716bcb commit 7b90ce1
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/fo4/file.rs
Original file line number Diff line number Diff line change
Expand Up @@ -83,12 +83,18 @@ impl ReadOptionsBuilder {
self
}

/// This setting corresponds to the _Single Mip Chunk Area_ setting from _Archive2.exe_.
/// This is __not__ the same as the size of the texture itself.
/// This is a heuristic for splitting mips into [chunks](Chunk).
/// Using anything other than the default setting is almost always a mistake.
/// Do not change this setting unless you know what you're doing.
#[must_use]
pub fn mip_chunk_height(mut self, mip_chunk_height: usize) -> Self {
self.0.mip_chunk_height = mip_chunk_height;
self
}

/// See also [`mip_chunk_height`](Self::mip_chunk_height).
#[must_use]
pub fn mip_chunk_width(mut self, mip_chunk_width: usize) -> Self {
self.0.mip_chunk_width = mip_chunk_width;
Expand Down

1 comment on commit 7b90ce1

@Niedzwiedzw
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

all right, good to know :D

Please sign in to comment.