[−][src]Struct amethyst_rendy::camera::Orthographic
An appropriate orthographic projection for the coordinate space used by Amethyst.
Because we use vulkan coordinates internally and within the rendering engine, normal nalgebra
projection objects (Orthographic3 are incorrect for our use case.
This implementation provides an interface with feature parity to nalgebra, but retaining the vulkan coordinate space.
Methods
impl Orthographic[src]
pub fn new(
left: f32,
right: f32,
bottom: f32,
top: f32,
z_near: f32,
z_far: f32
) -> Self[src]
left: f32,
right: f32,
bottom: f32,
top: f32,
z_near: f32,
z_far: f32
) -> Self
Create a new Orthographic projection with the provided parameters.
Arguments
left- The x-coordinate of the cuboid leftmost face parallel to the yz-plane.right- The x-coordinate of the cuboid rightmost face parallel to the yz-plane.top- The upper y-coordinate of the cuboid leftmost face parallel to the xz-plane.bottom- The lower y-coordinate of the cuboid leftmost face parallel to the xz-plane.z_near- The distance between the viewer (the origin) and the closest face of the cuboid parallel to the xy-plane. If used for a 3D rendering application, this is the closest clipping plane.z_far- The distance between the viewer (the origin) and the furthest face of the cuboid parallel to the xy-plane. If used for a 3D rendering application, this is the furthest clipping plane.
The projection matrix is right-handed and has a depth range of 0 to 1
pub fn top(&self) -> f32[src]
Returns the upper y-coordinate of the cuboid leftmost face parallel to the xz-plane.
pub fn bottom(&self) -> f32[src]
Returns the lower y-coordinate of the cuboid leftmost face parallel to the xz-plane.
pub fn left(&self) -> f32[src]
Returns the x-coordinate of the cuboid leftmost face parallel to the yz-plane.
pub fn right(&self) -> f32[src]
Returns the x-coordinate of the cuboid rightmost face parallel to the yz-plane.
pub fn near(&self) -> f32[src]
Returns the distance between the viewer (the origin) and the closest face of the cuboid parallel to the xy-plane. If used for a 3D rendering application, this is the closest clipping plane.
pub fn far(&self) -> f32[src]
Returns the distance between the viewer (the origin) and the furthest face of the cuboid parallel to the xy-plane. If used for a 3D rendering application, this is the furthest clipping plane.
pub fn set_top(&mut self, top: f32)[src]
Sets the y-coordinate of the cuboid leftmost face parallel to the xz-plane.
NOTE
Causes changes to both the top and bottom matrix elements.
pub fn set_bottom(&mut self, bottom: f32)[src]
Sets the y-coordinate of the cuboid leftmost face parallel to the xz-plane.
NOTE
Causes changes to both the top and bottom matrix elements.
pub fn set_bottom_and_top(&mut self, bottom: f32, top: f32)[src]
Sets y-axis of the projection.
pub fn set_left(&mut self, left: f32)[src]
Sets the x-coordinate of the cuboid leftmost face parallel to the yz-plane.
NOTE
Causes changes to both the left and right matrix elements.
pub fn set_right(&mut self, right: f32)[src]
Sets the x-coordinate of the cuboid rightmost face parallel to the yz-plane.
NOTE
Causes changes to both the left and right matrix elements.
pub fn set_left_and_right(&mut self, left: f32, right: f32)[src]
Sets x-axis of the projection.
pub fn set_near(&mut self, near: f32)[src]
Sets z-axis near clip of the projection.
NOTE
Causes changes to both the near and far matrix elements.
pub fn set_far(&mut self, far: f32)[src]
Sets the z-axis far clip of the projection.
NOTE
Causes changes to both the near and far matrix elements.
pub fn set_near_and_far(&mut self, z_near: f32, z_far: f32)[src]
Sets both the near and far z-axis clip values of the projection.
pub fn as_matrix(&self) -> &Matrix4<f32>[src]
Returns a reference to the inner matrix representation of this projection.
pub fn as_matrix_mut(&mut self) -> &mut Matrix4<f32>[src]
Returns a mutable reference to the inner matrix representation of this projection.
Trait Implementations
impl Copy for Orthographic[src]
impl Clone for Orthographic[src]
fn clone(&self) -> Orthographic[src]
fn clone_from(&mut self, source: &Self)1.0.0[src]
Performs copy-assignment from source. Read more
impl PartialEq<Orthographic> for Orthographic[src]
fn eq(&self, other: &Orthographic) -> bool[src]
fn ne(&self, other: &Orthographic) -> bool[src]
impl From<Orthographic> for Projection[src]
fn from(proj: Orthographic) -> Self[src]
impl Debug for Orthographic[src]
impl Serialize for Orthographic[src]
fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer, [src]
__S: Serializer,
impl<'de> Deserialize<'de> for Orthographic[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>, [src]
__D: Deserializer<'de>,
Auto Trait Implementations
impl Unpin for Orthographic
impl Sync for Orthographic
impl Send for Orthographic
impl UnwindSafe for Orthographic
impl RefUnwindSafe for Orthographic
Blanket Implementations
impl<T> ToOwned for T where
T: Clone, [src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T[src]
fn clone_into(&self, target: &mut T)[src]
impl<T> From<T> for T[src]
impl<T, U> Into<U> for T where
U: From<T>, [src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]
impl<T> Borrow<T> for T where
T: ?Sized, [src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized, [src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T[src]
impl<T> Any for T where
T: 'static + ?Sized, [src]
T: 'static + ?Sized,
impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where
D: AdaptFrom<S, Swp, Dwp, T>,
Dwp: WhitePoint,
Swp: WhitePoint,
T: Component + Float, [src]
D: AdaptFrom<S, Swp, Dwp, T>,
Dwp: WhitePoint,
Swp: WhitePoint,
T: Component + Float,
fn adapt_into_using<M>(self, method: M) -> D where
M: TransformMatrix<Swp, Dwp, T>, [src]
M: TransformMatrix<Swp, Dwp, T>,
fn adapt_into(self) -> D[src]
Convert the source color to the destination color using the bradford method by default Read more
impl<T> DeserializeOwned for T where
T: Deserialize<'de>, [src]
T: Deserialize<'de>,
impl<T> SetParameter for T[src]
fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where
T: Parameter<Self>, [src]
T: Parameter<Self>,
Sets value as a parameter of self.
impl<T> Supports<T> for T[src]
impl<T> Erased for T[src]
impl<T> Serialize for T where
T: Serialize + ?Sized, [src]
T: Serialize + ?Sized,
fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<Ok, Error>[src]
impl<T> Scalar for T where
T: Copy + PartialEq<T> + Any + Debug, [src]
T: Copy + PartialEq<T> + Any + Debug,
impl<T> Same<T> for T[src]
type Output = T
Should always be Self
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>, [src]
SS: SubsetOf<SP>,
fn to_subset(&self) -> Option<SS>[src]
fn is_in_subset(&self) -> bool[src]
unsafe fn to_subset_unchecked(&self) -> SS[src]
fn from_subset(element: &SS) -> SP[src]
impl<T> Resource for T where
T: Any + Send + Sync, [src]
T: Any + Send + Sync,
impl<T> Any for T where
T: Any, [src]
T: Any,
fn get_type_id(&self) -> TypeId[src]
impl<T> Event for T where
T: Send + Sync + 'static, [src]
T: Send + Sync + 'static,
impl<T> Clone for T where
T: Clone, [src]
T: Clone,