SkIPoint Struct Reference

#include <SkPoint_impl.h>

Public Member Functions
constexpr int32_t	x () const
constexpr int32_t	y () const
bool	isZero () const
void	set (int32_t x, int32_t y)
SkIPoint	operator- () const
void	operator+= (const SkIVector &v)
void	operator-= (const SkIVector &v)
bool	equals (int32_t x, int32_t y) const

Static Public Member Functions
static constexpr SkIPoint	Make (int32_t x, int32_t y)

Public Attributes
int32_t	fX
	x-axis value
int32_t	fY
	y-axis value

Friends
bool	operator== (const SkIPoint &a, const SkIPoint &b)
bool	operator!= (const SkIPoint &a, const SkIPoint &b)
SkIVector	operator- (const SkIPoint &a, const SkIPoint &b)
SkIPoint	operator+ (const SkIPoint &a, const SkIVector &b)

Detailed Description

SkIPoint holds two 32-bit integer coordinates.

Definition at line 28 of file SkPoint_impl.h.

Member Function Documentation

equals()

bool SkIPoint::equals ( int32_t  x, int32_t  y  ) const

inline

Returns true if SkIPoint is equivalent to SkIPoint constructed from (x, y).

Parameters

x	value compared with fX
y	value compared with fY

Returns

true if SkIPoint equals (x, y)

Definition at line 102 of file SkPoint_impl.h.

                                            {
        return fX == x && fY == y;
    }

isZero()

bool SkIPoint::isZero ( ) const

inline

Returns true if fX and fY are both zero.

Returns

true if fX is zero and fY is zero

Definition at line 58 of file SkPoint_impl.h.

{ return (fX | fY) == 0; }

Make()

static constexpr SkIPoint SkIPoint::Make ( int32_t  x, int32_t  y  )

inlinestaticconstexpr

Sets fX to x, fY to y.

Parameters

x	integer x-axis value of constructed SkIPoint
y	integer y-axis value of constructed SkIPoint

Returns

SkIPoint (x, y)

Definition at line 38 of file SkPoint_impl.h.

                                                         {
        return {x, y};
    }

operator+=()

void SkIPoint::operator+= ( const SkIVector &  v )

inline

Offsets SkIPoint by ivector v. Sets SkIPoint to (fX + v.fX, fY + v.fY).

Parameters

v	ivector to add

Definition at line 82 of file SkPoint_impl.h.

                                        {
        fX = Sk32_sat_add(fX, v.fX);
        fY = Sk32_sat_add(fY, v.fY);
    }

operator-()

SkIPoint SkIPoint::operator- ( ) const

inline

Returns SkIPoint changing the signs of fX and fY.

Returns

SkIPoint as (-fX, -fY)

Definition at line 74 of file SkPoint_impl.h.

                               {
        return {-fX, -fY};
    }

operator-=()

void SkIPoint::operator-= ( const SkIVector &  v )

inline

Subtracts ivector v from SkIPoint. Sets SkIPoint to: (fX - v.fX, fY - v.fY).

Parameters

v	ivector to subtract

Definition at line 91 of file SkPoint_impl.h.

                                        {
        fX = Sk32_sat_sub(fX, v.fX);
        fY = Sk32_sat_sub(fY, v.fY);
    }

set()

void SkIPoint::set ( int32_t  x, int32_t  y  )

inline

Sets fX to x and fY to y.

Parameters

x	new value for fX
y	new value for fY

Definition at line 65 of file SkPoint_impl.h.

                                   {
        fX = x;
        fY = y;
    }

x()

constexpr int32_t SkIPoint::x ( ) const

inlineconstexpr

Returns x-axis value of SkIPoint.

Returns

fX

Definition at line 46 of file SkPoint_impl.h.

{ return fX; }

y()

constexpr int32_t SkIPoint::y ( ) const

inlineconstexpr

Returns y-axis value of SkIPoint.

Returns

fY

Definition at line 52 of file SkPoint_impl.h.

{ return fY; }

Friends And Related Symbol Documentation

operator!=

bool operator!= ( const SkIPoint &  a, const SkIPoint &  b  )

friend

Returns true if a is not equivalent to b.

Parameters

a	SkIPoint to compare
b	SkIPoint to compare

Returns

true if a.fX != b.fX or a.fY != b.fY

Definition at line 122 of file SkPoint_impl.h.

                                                                 {
        return a.fX != b.fX || a.fY != b.fY;
    }

operator+

SkIPoint operator+ ( const SkIPoint &  a, const SkIVector &  b  )

friend

Returns SkIPoint resulting from SkIPoint a offset by ivector b, computed as: (a.fX + b.fX, a.fY + b.fY).

Can also be used to offset SkIPoint b by ivector a, returning SkIPoint. Can also be used to add ivector to ivector, returning ivector.

Parameters

a	SkIPoint or ivector to add to
b	SkIPoint or ivector to add

Returns

SkIPoint equal to a offset by b

Definition at line 148 of file SkPoint_impl.h.

                                                                     {
        return { Sk32_sat_add(a.fX, b.fX), Sk32_sat_add(a.fY, b.fY) };
    }

operator-

SkIVector operator- ( const SkIPoint &  a, const SkIPoint &  b  )

friend

Returns ivector from b to a; computed as (a.fX - b.fX, a.fY - b.fY).

Can also be used to subtract ivector from ivector, returning ivector.

Parameters

a	SkIPoint or ivector to subtract from
b	ivector to subtract

Returns

ivector from b to a

Definition at line 134 of file SkPoint_impl.h.

                                                                     {
        return { Sk32_sat_sub(a.fX, b.fX), Sk32_sat_sub(a.fY, b.fY) };
    }

operator==

bool operator== ( const SkIPoint &  a, const SkIPoint &  b  )

friend

Returns true if a is equivalent to b.

Parameters

a	SkIPoint to compare
b	SkIPoint to compare

Returns

true if a.fX == b.fX and a.fY == b.fY

Definition at line 112 of file SkPoint_impl.h.

                                                                 {
        return a.fX == b.fX && a.fY == b.fY;
    }

Member Data Documentation

fX

int32_t SkIPoint::fX

x-axis value

Definition at line 29 of file SkPoint_impl.h.

fY

int32_t SkIPoint::fY

y-axis value

Definition at line 30 of file SkPoint_impl.h.

---

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

• third_party/skia/include/private/base/SkPoint_impl.h