Burger::FixedVector2D_t Struct Reference

A 2D Fixed32 vector. More...

#include <fxfixed.h>

List of all members.

Public Member Functions
void BURGER_INLINE	Init (void)
	Initialize the vector elements to zero,.
void BURGER_INLINE	Set (Fixed32 fX, Fixed32 fY)
	Initialize the vector elements to specific values,.
void BURGER_INLINE	Zero (void)
	Initialize the vector elements to zero,.
Fixed32 BURGER_INLINE	GetX (void) const
	Return the x component of the vector.
Fixed32 BURGER_INLINE	GetY (void) const
	Return the y component of the vector.
void BURGER_INLINE	SetX (Fixed32 fX)
	Set the x component of the vector.
void BURGER_INLINE	SetY (Fixed32 fY)
	Set the y component of the vector.
Public Attributes
Fixed32	x
	X value for the 2D Vector.
Fixed32	y
	Y value for the 2D Vector.

---

Detailed Description

A 2D Fixed32 vector.

This 8 byte structure contains 2 32-bit Fixed point values as a 2D vector.

Note:

Since this is a structure, there is no constructor or destructor, so assume the data is uninitialized when creating this data type.

---

Member Function Documentation

Burger::FixedVector2D_t::GetX

(

void

)

const [inline]

Return the x component of the vector.

Returns:

The x component of the vector.

See also:

Burger::FixedVector2D_t::GetY(void) const or Burger::FixedVector2D_t::SetX(Fixed32)

Burger::FixedVector2D_t::GetY

(

void

)

const [inline]

Return the y component of the vector.

Returns:

The y component of the vector.

See also:

Burger::FixedVector2D_t::GetX(void) const or Burger::FixedVector2D_t::SetY(Fixed32)

Burger::FixedVector2D_t::Init

(

void

)

[inline]

Initialize the vector elements to zero,.

Fills in all of the entries with zero, thereby initializing the structure to a known state.

See also:

Burger::FixedVector2D_t::Zero(void) or Burger::FixedVector2D_t::Set(Fixed32,Fixed32)

Burger::FixedVector2D_t::Set	(	Fixed32	fX,
		Fixed32	fY
	)			[inline]

Initialize the vector elements to specific values,.

Given the new values for x and y, store them into the structure.

Parameters:

	fX	The new x component to store in the vector.
	fY	The new y component to store in the vector.

See also:

Burger::FixedVector2D_t::Init(void)

Burger::FixedVector2D_t::SetX

(

Fixed32

fX

)

[inline]

Set the x component of the vector.

Parameters:

fX

The new x component of the vector.

See also:

Burger::FixedVector2D_t::GetX(void) const

Burger::FixedVector2D_t::SetY

(

Fixed32

fY

)

[inline]

Set the y component of the vector.

Parameters:

fY

The new y component of the vector.

See also:

Burger::FixedVector2D_t::GetY(void) const

Burger::FixedVector2D_t::Zero

(

void

)

[inline]

Initialize the vector elements to zero,.

Fills in all of the entries with zero, thereby initializing the structure to a known state.

See also:

Burger::FixedVector2D_t::Init(void) or Burger::FixedVector2D_t::Set(Fixed32,Fixed32)

---

Member Data Documentation

Fixed32 Burger::FixedVector2D_t::x

X value for the 2D Vector.

Fixed32 Burger::FixedVector2D_t::y

Y value for the 2D Vector.