Struct ssbh_lib::Vector4

pub struct Vector4 {
    pub x: f32,
    pub y: f32,
    pub z: f32,
    pub w: f32,
}

4 contiguous floats for encoding XYZW or RGBA data.

Fields

x: f32

y: f32

z: f32

w: f32

Implementations

impl Vector4

pub const ZERO: Self = _

pub fn new(x: f32, y: f32, z: f32, w: f32) -> Vector4

pub fn xyz(&self) -> Vector3

pub fn to_array(&self) -> [f32; 4]

Converts the vector elements to an array.

Examples

assert_eq!([1.0, 2.0, 3.0, 4.0], Vector4::new(1.0, 2.0, 3.0, 4.0).to_array());

pub fn min(self, other: Vector4) -> Self

Returns the component-wise min of the two vectors. See f32::min.

Examples

let a = Vector4::new(1.0, 2.0, 3.0, 4.0);
let b = Vector4::new(5.0, 6.0, 7.0, 8.0);

assert_eq!(a.min(b), a);

pub fn max(self, other: Vector4) -> Self

Returns the component-wise max of the two vectors. See f32::max.

Examples

let a = Vector4::new(1.0, 2.0, 3.0, 4.0);
let b = Vector4::new(5.0, 6.0, 7.0, 8.0);

assert_eq!(a.max(b), b);

Trait Implementations

impl BinRead for Vector4

type Args<'__binrw_generated_args_lifetime> = ()

The type used for the args parameter of read_args() and read_options().

fn read_options<R: Read + Seek>( __binrw_generated_var_reader: &mut R, __binrw_generated_var_endian: Endian, __binrw_generated_var_arguments: Self::Args<'_> ) -> BinResult<Self>

Read Self from the reader using the given Endian and arguments.

fn read_be<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments and assuming big-endian byte order.

fn read_le<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments and assuming little-endian byte order.

fn read_ne<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read T from the reader assuming native-endian byte order.

fn read_be_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read Self from the reader, assuming big-endian byte order, using the given arguments.

fn read_le_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read Self from the reader, assuming little-endian byte order, using the given arguments.

fn read_ne_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read T from the reader, assuming native-endian byte order, using the given arguments.

impl Clone for Vector4

fn clone(&self) -> Vector4

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Vector4

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

Formats the value using the given formatter.

impl Default for Vector4

fn default() -> Vector4

Returns the “default value” for a type.

impl From<[f32; 4]> for Vector4

fn from(v: [f32; 4]) -> Self

Converts to this type from the input type.

impl From<(f32, f32, f32, f32)> for Vector4

fn from(v: (f32, f32, f32, f32)) -> Self

Converts to this type from the input type.

impl From<Vector4> for [f32; 4]

fn from(v: Vector4) -> Self

Converts to this type from the input type.

impl From<Vector4> for (f32, f32, f32, f32)

fn from(v: Vector4) -> Self

Converts to this type from the input type.

impl PartialEq for Vector4

fn eq(&self, other: &Vector4) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl SsbhWrite for Vector4

fn ssbh_write<W: Write + Seek>( &self, writer: &mut W, data_ptr: &mut u64 ) -> Result<()>

Writes the byte representation of self to writer. data_ptr is assumed to be the absolute offset where the next data stored behind an offset will be written. Struct that contains no offsets as fields can skip updating data_ptr.

fn size_in_bytes(&self) -> u64

The offset in bytes between successive elements in an array of this type. This should include any alignment or padding.

fn alignment_in_bytes() -> u64

The alignment for pointers of this type, which is useful for offset calculations.

fn write<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + Seek,

Writes the byte representation of self to writer. This is a convenience method for ssbh_write that handles initializing the data pointer.

impl Copy for Vector4

impl StructuralPartialEq for Vector4