BoundingFrustum Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Defines a frustum and helps determine whether forms intersect with it.

Inheritance Hierarchy

System.Object
  Microsoft.Xna.Framework.BoundingFrustum

Namespace:  Microsoft.Xna.Framework
Assembly:  Microsoft.Xna.Framework.Math (in Microsoft.Xna.Framework.Math.dll)

Syntax

'Declaration
Public Class BoundingFrustum

public class BoundingFrustum

The BoundingFrustum type exposes the following members.

Constructors

	Name	Description
	BoundingFrustum	Creates a new instance of BoundingFrustum.

Top

Properties

	Name	Description
	Bottom	Gets the bottom plane of the BoundingFrustum.
	Far	Gets the far plane of the BoundingFrustum.
	Left	Gets the left plane of the BoundingFrustum.
	Matrix	Gets or sets the Matrix that describes this bounding frustum.
	Near	Gets the near plane of the BoundingFrustum.
	Right	Gets the right plane of the BoundingFrustum.
	Top	Gets the top plane of the BoundingFrustum.

Top

Methods

	Name	Description
	Contains(BoundingBox)	Checks whether the current BoundingFrustum contains the specified BoundingBox.
	Contains(BoundingFrustum)	Checks whether the current BoundingFrustum contains the specified BoundingFrustum.
	Contains(BoundingSphere)	Checks whether the current BoundingFrustum contains the specified BoundingSphere.
	Contains(Vector3)	Checks whether the current BoundingFrustum contains the specified point.
	Contains(BoundingBox%, ContainmentType%)	Checks whether the current BoundingFrustum contains the specified BoundingBox.
	Contains(BoundingSphere%, ContainmentType%)	Checks whether the current BoundingFrustum contains the specified BoundingSphere.
	Contains(Vector3%, ContainmentType%)	Checks whether the current BoundingFrustum contains the specified point.
	Equals(Object)	Determines whether the specified Object is equal to the BoundingFrustum. (Overrides Object.Equals(Object).)
	Equals(BoundingFrustum)	Determines whether the specified BoundingFrustum is equal to the current BoundingFrustum.
	GetCorners()	Gets an array of points that make up the corners of the BoundingFrustum.
	GetCorners(array<Vector3[])	Gets an array of points that make up the corners of the BoundingFrustum.
	GetHashCode	Gets the hash code for this instance. (Overrides Object.GetHashCode().)
	Intersects(BoundingBox)	Checks whether the current BoundingFrustum intersects the specified BoundingBox.
	Intersects(BoundingFrustum)	Checks whether the current BoundingFrustum intersects the specified BoundingFrustum.
	Intersects(BoundingSphere)	Checks whether the current BoundingFrustum intersects the specified BoundingSphere.
	Intersects(Plane)	Checks whether the current BoundingFrustum intersects the specified Plane.
	Intersects(Ray)	Checks whether the current BoundingFrustum intersects the specified Ray.
	Intersects(BoundingBox%, Boolean%)	Checks whether the current BoundingFrustum intersects a BoundingBox.
	Intersects(BoundingSphere%, Boolean%)	Checks whether the current BoundingFrustum intersects a BoundingSphere.
	Intersects(Plane%, PlaneIntersectionType%)	Checks whether the current BoundingFrustum intersects a Plane.
	Intersects(Ray%, Nullable<Single>%)	Checks whether the current BoundingFrustum intersects a Ray.
	ToString	Returns a String that represents the current BoundingFrustum. (Overrides Object.ToString().)

Top

Operators

	Name	Description
	Equality	Determines whether two instances of BoundingFrustum are equal.
	Inequality	Determines whether two instances of BoundingFrustum are not equal.

Top

Fields

	Name	Description
	CornerCount	Specifies the total number of corners (8) in the BoundingFrustum.

Top

Remarks

A frustum in computer graphics is generally a volume of 3D space, defined as the part of a rectangular pyramid that lies between two planes perpendicular to its center line. A frustum is often used to represent what a "camera" sees in your 3D space.

The BoundingFrustum class allows you to define a bounding frustum using a combined matrix that is generally the product of a view matrix and a projection matrix.

You can query a BoundingFrustum object for any one of its bounding planes, for its corners, and for whether it intersects with a given object. Since objects that don't intersect with your view frustrum generally don't need to be rendered, culling them quickly can save you a lot of rendering time.

Version Information

Silverlight

Supported in: 5

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.Xna.Framework Namespace