Expand description
A 2-dimensional vector.
Fields§
§x: i32
§y: i32
Implementations§
source§impl IVec2
impl IVec2
sourcepub const NEG_X: IVec2 = Self::new(-1, 0)
pub const NEG_X: IVec2 = Self::new(-1, 0)
A unit-length vector pointing along the negative X axis.
sourcepub const NEG_Y: IVec2 = Self::new(0, -1)
pub const NEG_Y: IVec2 = Self::new(0, -1)
A unit-length vector pointing along the negative Y axis.
sourcepub fn select(mask: BVec2, if_true: IVec2, if_false: IVec2) -> IVec2
pub fn select(mask: BVec2, if_true: IVec2, if_false: IVec2) -> IVec2
Creates a vector from the elements in if_true
and if_false
, selecting which to use
for each element of self
.
A true element in the mask uses the corresponding element from if_true
, and false
uses the element from if_false
.
sourcepub const fn from_array(a: [i32; 2]) -> IVec2
pub const fn from_array(a: [i32; 2]) -> IVec2
Creates a new vector from an array.
sourcepub const fn from_slice(slice: &[i32]) -> IVec2
pub const fn from_slice(slice: &[i32]) -> IVec2
Creates a vector from the first 2 values in slice
.
Panics
Panics if slice
is less than 2 elements long.
sourcepub fn write_to_slice(self, slice: &mut [i32])
pub fn write_to_slice(self, slice: &mut [i32])
Writes the elements of self
to the first 2 elements in slice
.
Panics
Panics if slice
is less than 2 elements long.
sourcepub const fn extend(self, z: i32) -> IVec3
pub const fn extend(self, z: i32) -> IVec3
Creates a 3D vector from self
and the given z
value.
sourcepub fn dot_into_vec(self, rhs: IVec2) -> IVec2
pub fn dot_into_vec(self, rhs: IVec2) -> IVec2
Returns a vector where every component is the dot product of self
and rhs
.
sourcepub fn min(self, rhs: IVec2) -> IVec2
pub fn min(self, rhs: IVec2) -> IVec2
Returns a vector containing the minimum values for each element of self
and rhs
.
In other words this computes [self.x.min(rhs.x), self.y.min(rhs.y), ..]
.
sourcepub fn max(self, rhs: IVec2) -> IVec2
pub fn max(self, rhs: IVec2) -> IVec2
Returns a vector containing the maximum values for each element of self
and rhs
.
In other words this computes [self.x.max(rhs.x), self.y.max(rhs.y), ..]
.
sourcepub fn clamp(self, min: IVec2, max: IVec2) -> IVec2
pub fn clamp(self, min: IVec2, max: IVec2) -> IVec2
Component-wise clamping of values, similar to i32::clamp
.
Each element in min
must be less-or-equal to the corresponding element in max
.
Panics
Will panic if min
is greater than max
when glam_assert
is enabled.
sourcepub fn min_element(self) -> i32
pub fn min_element(self) -> i32
Returns the horizontal minimum of self
.
In other words this computes min(x, y, ..)
.
sourcepub fn max_element(self) -> i32
pub fn max_element(self) -> i32
Returns the horizontal maximum of self
.
In other words this computes max(x, y, ..)
.
sourcepub fn cmpeq(self, rhs: IVec2) -> BVec2
pub fn cmpeq(self, rhs: IVec2) -> BVec2
Returns a vector mask containing the result of a ==
comparison for each element of
self
and rhs
.
In other words, this computes [self.x == rhs.x, self.y == rhs.y, ..]
for all
elements.
sourcepub fn cmpne(self, rhs: IVec2) -> BVec2
pub fn cmpne(self, rhs: IVec2) -> BVec2
Returns a vector mask containing the result of a !=
comparison for each element of
self
and rhs
.
In other words this computes [self.x != rhs.x, self.y != rhs.y, ..]
for all
elements.
sourcepub fn cmpge(self, rhs: IVec2) -> BVec2
pub fn cmpge(self, rhs: IVec2) -> BVec2
Returns a vector mask containing the result of a >=
comparison for each element of
self
and rhs
.
In other words this computes [self.x >= rhs.x, self.y >= rhs.y, ..]
for all
elements.
sourcepub fn cmpgt(self, rhs: IVec2) -> BVec2
pub fn cmpgt(self, rhs: IVec2) -> BVec2
Returns a vector mask containing the result of a >
comparison for each element of
self
and rhs
.
In other words this computes [self.x > rhs.x, self.y > rhs.y, ..]
for all
elements.
sourcepub fn cmple(self, rhs: IVec2) -> BVec2
pub fn cmple(self, rhs: IVec2) -> BVec2
Returns a vector mask containing the result of a <=
comparison for each element of
self
and rhs
.
In other words this computes [self.x <= rhs.x, self.y <= rhs.y, ..]
for all
elements.
sourcepub fn cmplt(self, rhs: IVec2) -> BVec2
pub fn cmplt(self, rhs: IVec2) -> BVec2
Returns a vector mask containing the result of a <
comparison for each element of
self
and rhs
.
In other words this computes [self.x < rhs.x, self.y < rhs.y, ..]
for all
elements.
sourcepub fn abs(self) -> IVec2
pub fn abs(self) -> IVec2
Returns a vector containing the absolute value of each element of self
.
sourcepub fn signum(self) -> IVec2
pub fn signum(self) -> IVec2
Returns a vector with elements representing the sign of self
.
1.0
if the number is positive,+0.0
orINFINITY
-1.0
if the number is negative,-0.0
orNEG_INFINITY
NAN
if the number isNAN
sourcepub fn is_negative_bitmask(self) -> u32
pub fn is_negative_bitmask(self) -> u32
Returns a bitmask with the lowest 2 bits set to the sign bits from the elements of self
.
A negative element results in a 1
bit and a positive element in a 0
bit. Element x
goes
into the first lowest bit, element y
into the second, etc.
sourcepub fn perp_dot(self, rhs: IVec2) -> i32
pub fn perp_dot(self, rhs: IVec2) -> i32
The perpendicular dot product of self
and rhs
.
Also known as the wedge product, 2D cross product, and determinant.
Trait Implementations§
source§impl AddAssign<IVec2> for IVec2
impl AddAssign<IVec2> for IVec2
source§fn add_assign(&mut self, rhs: IVec2)
fn add_assign(&mut self, rhs: IVec2)
+=
operation. Read moresource§impl AddAssign<i32> for IVec2
impl AddAssign<i32> for IVec2
source§fn add_assign(&mut self, rhs: i32)
fn add_assign(&mut self, rhs: i32)
+=
operation. Read more§impl AsMutVectorParts<i32, 2> for IVec2where
IVec2: AsMut<[i32; 2]>,
i32: VectorScalar,
impl AsMutVectorParts<i32, 2> for IVec2where
IVec2: AsMut<[i32; 2]>,
i32: VectorScalar,
fn as_mut_parts(&mut self) -> &mut [i32; 2]
§impl AsRefVectorParts<i32, 2> for IVec2where
IVec2: AsRef<[i32; 2]>,
i32: VectorScalar,
impl AsRefVectorParts<i32, 2> for IVec2where
IVec2: AsRef<[i32; 2]>,
i32: VectorScalar,
fn as_ref_parts(&self) -> &[i32; 2]
§impl CreateFrom for IVec2where
IVec2: FromVectorParts<i32, 2>,
i32: VectorScalar + CreateFrom,
impl CreateFrom for IVec2where
IVec2: FromVectorParts<i32, 2>,
i32: VectorScalar + CreateFrom,
fn create_from<B>(reader: &mut Reader<B>) -> IVec2where
B: BufferRef,
source§impl<'de> Deserialize<'de> for IVec2
impl<'de> Deserialize<'de> for IVec2
source§fn deserialize<D>(
deserializer: D
) -> Result<IVec2, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
fn deserialize<D>(
deserializer: D
) -> Result<IVec2, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
source§impl DivAssign<IVec2> for IVec2
impl DivAssign<IVec2> for IVec2
source§fn div_assign(&mut self, rhs: IVec2)
fn div_assign(&mut self, rhs: IVec2)
/=
operation. Read moresource§impl DivAssign<i32> for IVec2
impl DivAssign<i32> for IVec2
source§fn div_assign(&mut self, rhs: i32)
fn div_assign(&mut self, rhs: i32)
/=
operation. Read more§impl FromReflect for IVec2where
i32: FromReflect,
impl FromReflect for IVec2where
i32: FromReflect,
§fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<IVec2>
fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<IVec2>
Self
from a reflected value.§impl FromVectorParts<i32, 2> for IVec2where
IVec2: From<[i32; 2]>,
i32: VectorScalar,
impl FromVectorParts<i32, 2> for IVec2where
IVec2: From<[i32; 2]>,
i32: VectorScalar,
fn from_parts(parts: [i32; 2]) -> IVec2
§impl GetTypeRegistration for IVec2
impl GetTypeRegistration for IVec2
source§impl MulAssign<IVec2> for IVec2
impl MulAssign<IVec2> for IVec2
source§fn mul_assign(&mut self, rhs: IVec2)
fn mul_assign(&mut self, rhs: IVec2)
*=
operation. Read moresource§impl MulAssign<i32> for IVec2
impl MulAssign<i32> for IVec2
source§fn mul_assign(&mut self, rhs: i32)
fn mul_assign(&mut self, rhs: i32)
*=
operation. Read more§impl ReadFrom for IVec2where
IVec2: AsMutVectorParts<i32, 2>,
i32: VectorScalar + ReadFrom,
impl ReadFrom for IVec2where
IVec2: AsMutVectorParts<i32, 2>,
i32: VectorScalar + ReadFrom,
§impl Reflect for IVec2
impl Reflect for IVec2
§fn get_type_info(&self) -> &'static TypeInfo
fn get_type_info(&self) -> &'static TypeInfo
§fn into_any(self: Box<IVec2, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<IVec2, Global>) -> Box<dyn Any + 'static, Global>
Box<dyn Any>
.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut dyn Any
.§fn into_reflect(self: Box<IVec2, Global>) -> Box<dyn Reflect + 'static, Global>
fn into_reflect(self: Box<IVec2, Global>) -> Box<dyn Reflect + 'static, Global>
§fn as_reflect(&self) -> &(dyn Reflect + 'static)
fn as_reflect(&self) -> &(dyn Reflect + 'static)
§fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)
fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)
§fn clone_value(&self) -> Box<dyn Reflect + 'static, Global>
fn clone_value(&self) -> Box<dyn Reflect + 'static, Global>
Reflect
trait object. Read more§fn set(
&mut self,
value: Box<dyn Reflect + 'static, Global>
) -> Result<(), Box<dyn Reflect + 'static, Global>>
fn set(
&mut self,
value: Box<dyn Reflect + 'static, Global>
) -> Result<(), Box<dyn Reflect + 'static, Global>>
§fn apply(&mut self, value: &(dyn Reflect + 'static))
fn apply(&mut self, value: &(dyn Reflect + 'static))
§fn reflect_ref(&self) -> ReflectRef<'_>
fn reflect_ref(&self) -> ReflectRef<'_>
§fn reflect_mut(&mut self) -> ReflectMut<'_>
fn reflect_mut(&mut self) -> ReflectMut<'_>
§fn reflect_owned(self: Box<IVec2, Global>) -> ReflectOwned
fn reflect_owned(self: Box<IVec2, Global>) -> ReflectOwned
§fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>
fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>
§fn debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>
fn debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>
§fn reflect_hash(&self) -> Option<u64>
fn reflect_hash(&self) -> Option<u64>
§fn serializable(&self) -> Option<Serializable<'_>>
fn serializable(&self) -> Option<Serializable<'_>>
source§impl RemAssign<IVec2> for IVec2
impl RemAssign<IVec2> for IVec2
source§fn rem_assign(&mut self, rhs: IVec2)
fn rem_assign(&mut self, rhs: IVec2)
%=
operation. Read moresource§impl RemAssign<i32> for IVec2
impl RemAssign<i32> for IVec2
source§fn rem_assign(&mut self, rhs: i32)
fn rem_assign(&mut self, rhs: i32)
%=
operation. Read moresource§impl Serialize for IVec2
impl Serialize for IVec2
source§fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
§impl ShaderSize for IVec2where
i32: ShaderSize,
impl ShaderSize for IVec2where
i32: ShaderSize,
§const SHADER_SIZE: NonZeroU64 = Self::METADATA.min_size().0
const SHADER_SIZE: NonZeroU64 = Self::METADATA.min_size().0
ShaderType::min_size
)§impl ShaderType for IVec2where
i32: ShaderSize,
impl ShaderType for IVec2where
i32: ShaderSize,
§fn min_size() -> NonZeroU64
fn min_size() -> NonZeroU64
§fn size(&self) -> NonZeroU64
fn size(&self) -> NonZeroU64
Self
at runtime Read more§fn assert_uniform_compat()
fn assert_uniform_compat()
Self
meets the requirements of the
uniform address space restrictions on stored values and the
uniform address space layout constraints Read more§impl Struct for IVec2
impl Struct for IVec2
§fn field_at_mut(&mut self, index: usize) -> Option<&mut (dyn Reflect + 'static)>
fn field_at_mut(&mut self, index: usize) -> Option<&mut (dyn Reflect + 'static)>
index
as a &mut dyn Reflect
. Read more§fn iter_fields(&self) -> FieldIter<'_> ⓘ
fn iter_fields(&self) -> FieldIter<'_> ⓘ
§fn clone_dynamic(&self) -> DynamicStruct
fn clone_dynamic(&self) -> DynamicStruct
DynamicStruct
.source§impl SubAssign<IVec2> for IVec2
impl SubAssign<IVec2> for IVec2
source§fn sub_assign(&mut self, rhs: IVec2)
fn sub_assign(&mut self, rhs: IVec2)
-=
operation. Read moresource§impl SubAssign<i32> for IVec2
impl SubAssign<i32> for IVec2
source§fn sub_assign(&mut self, rhs: i32)
fn sub_assign(&mut self, rhs: i32)
-=
operation. Read moresource§impl Vec2Swizzles for IVec2
impl Vec2Swizzles for IVec2
type Vec3 = IVec3
type Vec4 = IVec4
fn xx(self) -> IVec2
fn xy(self) -> IVec2
fn yx(self) -> IVec2
fn yy(self) -> IVec2
fn xxx(self) -> IVec3
fn xxy(self) -> IVec3
fn xyx(self) -> IVec3
fn xyy(self) -> IVec3
fn yxx(self) -> IVec3
fn yxy(self) -> IVec3
fn yyx(self) -> IVec3
fn yyy(self) -> IVec3
fn xxxx(self) -> IVec4
fn xxxy(self) -> IVec4
fn xxyx(self) -> IVec4
fn xxyy(self) -> IVec4
fn xyxx(self) -> IVec4
fn xyxy(self) -> IVec4
fn xyyx(self) -> IVec4
fn xyyy(self) -> IVec4
fn yxxx(self) -> IVec4
fn yxxy(self) -> IVec4
fn yxyx(self) -> IVec4
fn yxyy(self) -> IVec4
fn yyxx(self) -> IVec4
fn yyxy(self) -> IVec4
fn yyyx(self) -> IVec4
fn yyyy(self) -> IVec4
§impl WriteInto for IVec2where
IVec2: AsRefVectorParts<i32, 2>,
i32: VectorScalar + WriteInto,
impl WriteInto for IVec2where
IVec2: AsRefVectorParts<i32, 2>,
i32: VectorScalar + WriteInto,
fn write_into<B>(&self, writer: &mut Writer<B>)where
B: BufferMut,
impl Copy for IVec2
impl Eq for IVec2
impl Pod for IVec2
impl StructuralEq for IVec2
impl StructuralPartialEq for IVec2
Auto Trait Implementations§
impl RefUnwindSafe for IVec2
impl Send for IVec2
impl Sync for IVec2
impl Unpin for IVec2
impl UnwindSafe for IVec2
Blanket Implementations§
§impl<T, U> AsBindGroupShaderType<U> for Twhere
U: ShaderType,
&'a T: for<'a> Into<U>,
impl<T, U> AsBindGroupShaderType<U> for Twhere
U: ShaderType,
&'a T: for<'a> Into<U>,
§fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist. Read more§impl<T> CheckedBitPattern for Twhere
T: AnyBitPattern,
impl<T> CheckedBitPattern for Twhere
T: AnyBitPattern,
§type Bits = T
type Bits = T
Self
must have the same layout as the specified Bits
except for
the possible invalid bit patterns being checked during
is_valid_bit_pattern
. Read more§fn is_valid_bit_pattern(_bits: &T) -> bool
fn is_valid_bit_pattern(_bits: &T) -> bool
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read more§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read moresource§impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Self
using data from the given World§impl<S> GetField for Swhere
S: Struct,
impl<S> GetField for Swhere
S: Struct,
§impl<T> GetPath for Twhere
T: Reflect,
impl<T> GetPath for Twhere
T: Reflect,
§fn path<'r, 'p>(
&'r self,
path: &'p str
) -> Result<&'r (dyn Reflect + 'static), ReflectPathError<'p>>
fn path<'r, 'p>(
&'r self,
path: &'p str
) -> Result<&'r (dyn Reflect + 'static), ReflectPathError<'p>>
path
. Read more§fn path_mut<'r, 'p>(
&'r mut self,
path: &'p str
) -> Result<&'r mut (dyn Reflect + 'static), ReflectPathError<'p>>
fn path_mut<'r, 'p>(
&'r mut self,
path: &'p str
) -> Result<&'r mut (dyn Reflect + 'static), ReflectPathError<'p>>
path
. Read more§fn get_path<T, 'r, 'p>(
&'r self,
path: &'p str
) -> Result<&'r T, ReflectPathError<'p>>where
T: Reflect,
fn get_path<T, 'r, 'p>(
&'r self,
path: &'p str
) -> Result<&'r T, ReflectPathError<'p>>where
T: Reflect,
path
.§fn get_path_mut<T, 'r, 'p>(
&'r mut self,
path: &'p str
) -> Result<&'r mut T, ReflectPathError<'p>>where
T: Reflect,
fn get_path_mut<T, 'r, 'p>(
&'r mut self,
path: &'p str
) -> Result<&'r mut T, ReflectPathError<'p>>where
T: Reflect,
path
. Read more