Struct graphene::Frustum

#[repr(transparent)]
pub struct Frustum { /* private fields */ }

A 3D volume delimited by 2D clip planes.

The contents of the Frustum are private, and should not be modified directly.

Implementations

impl Frustum

pub fn as_ptr(&self) -> *mut graphene_frustum_t

impl Frustum

pub fn contains_point(&self, point: &Point3D) -> bool

Checks whether a point is inside the volume defined by the given Frustum.

point

a Point3D

Returns

true if the point is inside the frustum

pub fn intersects_box(&self, box_: &Box) -> bool

Checks whether the given box_ intersects a plane of a Frustum.

box_

a Box

Returns

true if the box intersects the frustum

pub fn intersects_sphere(&self, sphere: &Sphere) -> bool

Checks whether the given sphere intersects a plane of a Frustum.

sphere

a Sphere

Returns

true if the sphere intersects the frustum

impl Frustum

pub fn planes(&self) -> &[Plane; 6]

Retrieves the planes that define the given Frustum.

Returns

planes

return location for an array of 6 Plane

pub fn new( p0: &Plane, p1: &Plane, p2: &Plane, p3: &Plane, p4: &Plane, p5: &Plane ) -> Self

Initializes the given Frustum using the provided clipping planes.

p0

a clipping plane

p1

a clipping plane

p2

a clipping plane

p3

a clipping plane

p4

a clipping plane

p5

a clipping plane

Returns

the initialized frustum

pub fn from_matrix(matrix: &Matrix) -> Self

Initializes a Frustum using the given matrix.

matrix

a Matrix

Returns

the initialized frustum

Trait Implementations

impl Clone for Frustum

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Frustum

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

Formats the value using the given formatter.

impl PartialEq<Frustum> for Frustum

fn eq(&self, other: &Self) -> 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 StaticType for Frustum

fn static_type() -> Type

Returns the type identifier of Self.

impl Copy for Frustum

impl Eq for Frustum