The structure that defines a point (using floating point values). More...

Inheritance diagram for SDL::FPoint:

Collaboration diagram for SDL::FPoint:

Public Member Functions
constexpr	FPoint (const FPointRaw &p={}) noexcept
	Wraps FPoint. More...

constexpr	FPoint (float x, float y) noexcept
	Constructs from its fields. More...

constexpr	operator bool () const noexcept
	Check if valid. More...

constexpr float	GetX () const noexcept
	Get the x coordinate. More...

constexpr FPoint &	SetX (float newX) noexcept
	Set the x coordinate. More...

constexpr float	GetY () const noexcept
	Get the y coordinate. More...

constexpr FPoint &	SetY (float newY) noexcept
	Set the y coordinate. More...

constexpr bool	InRect (const FRectRaw &r) const
	Determine whether a point resides inside a floating point rectangle. More...

constexpr FPoint	operator- () const
	Get point's memberwise negation. More...

constexpr FPoint	operator+ (const FPoint &other) const
	Get point's memberwise addition with another point. More...

constexpr FPoint	operator- (const FPoint &other) const
	Get point's memberwise subtraction with another point. More...

constexpr FPoint	operator/ (float value) const
	Get point's memberwise division by an float. More...

constexpr FPoint	operator/ (const FPoint &other) const
	Get point's memberwise division by another point. More...

constexpr FPoint	operator* (float value) const
	Get point's memberwise multiplication by an float. More...

constexpr FPoint	operator* (const FPoint &other) const
	Get point's memberwise multiplication by another point. More...

constexpr FPoint &	operator+= (const FPoint &other)
	Memberwise add another point. More...

constexpr FPoint &	operator-= (const FPoint &other)
	Memberwise subtract another point. More...

constexpr FPoint &	operator/= (float value)
	Memberwise divide by an float. More...

constexpr FPoint &	operator/= (const FPoint &other)
	Memberwise divide by another point. More...

constexpr FPoint &	operator*= (float value)
	Memberwise multiply by an float. More...

constexpr FPoint &	operator*= (const FPoint &other)
	Memberwise multiply by another point. More...

constexpr FPoint	GetClamped (const FRect &rect) const
	Get a point with coordinates modified so it fits into a given rect. More...

constexpr FPoint &	Clamp (const FRect &rect)
	Clamp point coordinates to make it fit into a given rect. More...

constexpr FPoint	GetWrapped (const FRect &rect) const
	Get a point wrapped within a specified rect. More...

constexpr FPoint &	Wrap (const FRect &rect)
	Wrap point coordinates within a specified rect. More...

Detailed Description

Since: This struct is available since SDL 3.2.0.

Category:: Wrap extending struct

See also: FRect.GetEnclosingPoints; FPoint.InRect

Constructor & Destructor Documentation

◆ FPoint() [1/2]

constexpr SDL::FPoint::FPoint ( const FPointRaw & p = {} )

inlineconstexprnoexcept

Parameters

p	the value to be wrapped

◆ FPoint() [2/2]

constexpr SDL::FPoint::FPoint	(	float	x,
		float	y
	)

inlineconstexprnoexcept

Parameters

x	the value for x.
y	the value for y.

Member Function Documentation

◆ Clamp()

constexpr FPoint & SDL::FPoint::Clamp ( const FRect & rect )

constexpr

Parameters

[in] rect Rectangle to clamp with

Returns: Reference to self

◆ GetClamped()

constexpr FPoint SDL::FPoint::GetClamped ( const FRect & rect ) const

constexpr

Parameters

[in] rect Rectangle to clamp with

Returns: Clamped point

◆ GetWrapped()

constexpr FPoint SDL::FPoint::GetWrapped ( const FRect & rect ) const

constexpr

Parameters

[in] rect Rectangle to wrap with

Returns: Wrapped point

◆ GetX()

constexpr float SDL::FPoint::GetX ( ) const

inlineconstexprnoexcept

Returns: current x value.

◆ GetY()

constexpr float SDL::FPoint::GetY ( ) const

inlineconstexprnoexcept

Returns: current y coordinate.

◆ operator bool()

constexpr SDL::FPoint::operator bool ( ) const

inlineexplicitconstexprnoexcept

Returns: True if valid state, false otherwise.

◆ operator*() [1/2]

constexpr FPoint SDL::FPoint::operator* ( const FPoint & other ) const

inlineconstexpr

Parameters

[in] other Multiplier

Returns: New Point representing memberwise multiplication of point by another point

◆ operator*() [2/2]

constexpr FPoint SDL::FPoint::operator* ( float value ) const

inlineconstexpr

Parameters

[in] value Multiplier

Returns: New Point representing memberwise multiplication of point by an float

◆ operator*=() [1/2]

constexpr FPoint & SDL::FPoint::operator*= ( const FPoint & other )

inlineconstexpr

Parameters

[in] other Multiplier

Returns: Reference to self

◆ operator*=() [2/2]

constexpr FPoint & SDL::FPoint::operator*= ( float value )

inlineconstexpr

Parameters

[in] value Multiplier

Returns: Reference to self

◆ operator+()

constexpr FPoint SDL::FPoint::operator+ ( const FPoint & other ) const

inlineconstexpr

Parameters

[in] other Point to add

Returns: New Point representing memberwise addition with another point

◆ operator+=()

constexpr FPoint & SDL::FPoint::operator+= ( const FPoint & other )

inlineconstexpr

Parameters

[in] other Point to add to the current one

Returns: Reference to self

◆ operator-() [1/2]

constexpr FPoint SDL::FPoint::operator- ( ) const

inlineconstexpr

Returns: New Point representing memberwise negation

◆ operator-() [2/2]

constexpr FPoint SDL::FPoint::operator- ( const FPoint & other ) const

inlineconstexpr

Parameters

[in] other Point to subtract

Returns: New Point representing memberwise subtraction of another point

◆ operator-=()

constexpr FPoint & SDL::FPoint::operator-= ( const FPoint & other )

inlineconstexpr

Parameters

[in] other Point to subtract from the current one

Returns: Reference to self

◆ operator/() [1/2]

constexpr FPoint SDL::FPoint::operator/ ( const FPoint & other ) const

inlineconstexpr

Parameters

[in] other Divisor

Returns: New Point representing memberwise division of point by another point

◆ operator/() [2/2]

constexpr FPoint SDL::FPoint::operator/ ( float value ) const

inlineconstexpr

Parameters

[in] value Divisor

Returns: New Point representing memberwise division of point by an float

◆ operator/=() [1/2]

constexpr FPoint & SDL::FPoint::operator/= ( const FPoint & other )

inlineconstexpr

Parameters

[in] other Divisor

Returns: Reference to self

◆ operator/=() [2/2]

constexpr FPoint & SDL::FPoint::operator/= ( float value )

inlineconstexpr

Parameters

[in] value Divisor

Returns: Reference to self

◆ SetX()

constexpr FPoint & SDL::FPoint::SetX ( float newX )

inlineconstexprnoexcept

Parameters

newX	the new x coordinate.

Returns: Reference to self.

◆ SetY()

constexpr FPoint & SDL::FPoint::SetY ( float newY )

inlineconstexprnoexcept

Parameters

newY	the new y coordinate.

Returns: Reference to self.

◆ Wrap()

constexpr FPoint & SDL::FPoint::Wrap ( const FRect & rect )

constexpr

Parameters

[in] rect Rectangle to wrap with

Returns: Reference to self

The documentation for this struct was generated from the following file:

SDL3pp/SDL3pp_rect.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ FPoint() [1/2]

◆ FPoint() [2/2]

Member Function Documentation

◆ Clamp()

◆ GetClamped()

◆ GetWrapped()

◆ GetX()

◆ GetY()

◆ operator bool()

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator*=() [1/2]

◆ operator*=() [2/2]

◆ operator+()

◆ operator+=()

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator-=()

◆ operator/() [1/2]

◆ operator/() [2/2]

◆ operator/=() [1/2]

◆ operator/=() [2/2]

◆ SetX()

◆ SetY()

◆ Wrap()