前のページ次のページ上に戻るホーム SophiaFramework UNIVERSE 5.3
SFXPixel
画面上の画素（ピクセル）を表すピクセル座標を扱うためのクラスです。
#include <SFXPixel.h.hpp>
class SFXPixel;
SFMTYPEDEFCLASS(SFXPixel)

解説

SFXPixel クラスは、画面上の画素（ピクセル）を表すピクセル座標を扱うためのクラスです。

SFXPixel::AtomRec 構造体は画面上の画素（ピクセル）を表すピクセル座標を表す構造体であり、 画素（ピクセル）の X 座標と Y 座標を持ちます。

定数の SFXPixel インスタンスは、コンストラクタを呼び出すことなく、 SFXPixel::AtomRec 構造体を利用して高速に設定することが可能です。

[Note] グリッド座標系とピクセル座標系

SophiaFramework UNIVERSE には、グリッド座標系とピクセル座標系の 2 つの座標系があります。

両者の違いを図で表すと、次のようになります。

囲碁や将棋に例えると、 「描画する平面」は盤面、 「グリッド」は囲碁の碁石を置く場所、 「ピクセル」は将棋の駒を置く場所です。

参照

SFXPixel::AtomRec | SFXGrid | BREW API AEEPoint

メンバ

コンストラクタ/デストラクタ
SFXPixel( Void )
SFXPixel クラスのコンストラクタです。
SFXPixel( SFXPixelConstRef param )
SFXPixel クラスのコンストラクタです。
SFXPixel( SInt16 x , SInt16 y )
SFXPixel クラスのコンストラクタです。
パブリック関数
SFXPixelRef Add( SFXPixelConstRef param )
このピクセルの座標に指定された値を加算します。
SFXPixelRef Add( SInt16 x , SInt16 y )
このピクセルの座標に指定された値を加算します。
SFXPixelRef AddX( SInt16 param )
このピクセルの X 座標に指定された値を加算します。
SFXPixelRef AddY( SInt16 param )
このピクセルの Y 座標に指定された値を加算します。
SFXPixelRef Div( SInt16 x , SInt16 y )
このピクセルの座標を指定された値で除算します。
SFXPixelRef Div( SInt16 param )
このピクセルの座標を指定された値で除算します。
SFXPixelRef DivX( SInt16 param )
このピクセルの X 座標を指定された値で除算します。
SFXPixelRef DivY( SInt16 param )
このピクセルの Y 座標を指定された値で除算します。
Bool Equals( SFXPixelConstRef param )
このピクセルの座標が指定された値と等しいか判定します。
Bool Equals( SInt16 x , SInt16 y )
このピクセルの座標が指定された値と等しいか判定します。
SInt16 GetBottom( Void )
このピクセルの右下端・左下端格子点の Y 座標を取得します。
SInt16 GetLeft( Void )
このピクセルの左上端・左下端格子点の X 座標を取得します。
SFXGrid GetLeftBottom( Void )
このピクセルの左下端格子点の座標を取得します。
SFXGrid GetLeftTop( Void )
このピクセルの左上端格子点の座標を取得します。
SInt16 GetRight( Void )
このピクセルの右上端・右下端格子点の X 座標を取得します。
SFXGrid GetRightBottom( Void )
このピクセルの右下端格子点の座標を取得します。
SFXGrid GetRightTop( Void )
このピクセルの右上端格子点の座標を取得します。
SInt16 GetTop( Void )
このピクセルの右上端・左上端格子点の Y 座標を取得します。
SInt16 GetX( Void )
このピクセルの X 座標を取得します。
SInt16 GetY( Void )
このピクセルの Y 座標を取得します。
Bool IsInsideOf( SFXRectangleConstRef param )
このピクセルの座標が指定された矩形領域の中に含まれるか判定します。
SFXPixelRef Mod( SInt16 x , SInt16 y )
このピクセルの座標を指定された値で剰余します。
SFXPixelRef Mod( SInt16 param )
このピクセルの座標を指定された値で剰余します。
SFXPixelRef ModX( SInt16 param )
このピクセルの X 座標を指定された値で剰余します。
SFXPixelRef ModY( SInt16 param )
このピクセルの Y 座標を指定された値で剰余します。
SFXPixelRef Mul( SInt16 x , SInt16 y )
このピクセルの座標に指定された値を乗算します。
SFXPixelRef Mul( SInt16 param )
このピクセルの座標に指定された値を乗算します。
SFXPixelRef MulX( SInt16 param )
このピクセルの X 座標に指定された値を乗算します。
SFXPixelRef MulY( SInt16 param )
このピクセルの Y 座標に指定された値を乗算します。
SFXPixelRef Neg( Void )
このピクセルの座標の符号を反転します。
SFXPixelRef NegX( Void )
このピクセルの X 座標の符号を反転します。
SFXPixelRef NegY( Void )
このピクセルの Y 座標の符号を反転します。
SFXPixelRef Offset( SFXGridConstRef param )
このピクセルの座標に指定された値を加算します（このピクセルは、引数に指定された値に応じて移動します）。
SFXPixelRef Offset( SInt16 x , SInt16 y )
このピクセルの座標に指定された値を加算します（このピクセルは、引数に指定された値に応じて移動します）。
SFXPixelRef Set( SFXPixelConstRef param )
このピクセルの座標を指定された値に設定します。
SFXPixelRef Set( SInt16 x , SInt16 y )
このピクセルの座標を指定された値に設定します。
SFXPixelRef SetBottom( SInt16 param )
右下端・左下端格子点の Y 座標を指定してこのピクセルの Y 座標を設定します。
SFXPixelRef SetLeft( SInt16 param )
左上端・左下端格子点の X 座標を指定してこのピクセルの X 座標を設定します。
SFXPixelRef SetLeftBottom( SFXGridConstRef param )
左下端格子点の座標を指定してこのピクセルの座標を設定します。
SFXPixelRef SetLeftBottom( SInt16 x , SInt16 y )
左下端格子点の座標を指定してこのピクセルの座標を設定します。
SFXPixelRef SetLeftTop( SFXGridConstRef param )
左上端格子点の座標を指定してこのピクセルの座標を設定します。
SFXPixelRef SetLeftTop( SInt16 x , SInt16 y )
左上端格子点の座標を指定してこのピクセルの座標を設定します。
SFXPixelRef SetRight( SInt16 param )
右上端・右下端格子点の X 座標を指定してこのピクセルの X 座標を設定します。
SFXPixelRef SetRightBottom( SFXGridConstRef param )
右下端格子点の座標を指定してこのピクセルの座標を設定します。
SFXPixelRef SetRightBottom( SInt16 x , SInt16 y )
右下端格子点の座標を指定してこのピクセルの座標を設定します。
SFXPixelRef SetRightTop( SFXGridConstRef param )
右上端格子点の座標を指定してこのピクセルの座標を設定します。
SFXPixelRef SetRightTop( SInt16 x , SInt16 y )
右上端格子点の座標を指定してこのピクセルの座標を設定します。
SFXPixelRef SetTop( SInt16 param )
右上端・左上端格子点の Y 座標を指定してこのピクセルの Y 座標を設定します。
SFXPixelRef SetX( SInt16 param )
このピクセルの X 座標を指定された値に設定します。
SFXPixelRef SetY( SInt16 param )
このピクセルの Y 座標を指定された値に設定します。
SFXPixelRef Sub( SFXPixelConstRef param )
このピクセルの座標から指定された値を減算します。
SFXPixelRef Sub( SInt16 x , SInt16 y )
このピクセルの座標から指定された値を減算します。
SFXPixelRef SubX( SInt16 param )
このピクセルの X 座標から指定された値を減算します。
SFXPixelRef SubY( SInt16 param )
このピクセルの Y 座標から指定された値を減算します。
SFXPixelRef Unoffset( SFXGridConstRef param )
このピクセルの座標から指定された値を減算します（このピクセルは、引数に指定された値に応じて移動します）。
SFXPixelRef Unoffset( SInt16 x , SInt16 y )
このピクセルの座標から指定された値を減算します（このピクセルは、引数に指定された値に応じて移動します）。
static
SFXPixelConstRef 		ZeroInstance( Void )
0 を表す SFXPixel インスタンスを取得します。
SFXPixelRef operator%=( SInt16 param )
左側のピクセルの座標を右側の値で剰余します。
SFXPixelRef operator*=( SInt16 param )
左側のピクセルの座標を右側の値で乗算します。
SFXPixelRef operator+=( SFXPixelConstRef param )
左側のピクセルの座標に右側の値を加算します。
SFXPixelRef operator+=( SFXGridConstRef param )
左側のピクセルの座標に右側の値を加算します。
SFXPixelRef operator-=( SFXPixelConstRef param )
左側のピクセルの座標から右側の値を減算します。
SFXPixelRef operator-=( SFXGridConstRef param )
左側のピクセルの座標から右側の値を減算します。
SFXPixelRef operator/=( SInt16 param )
左側のピクセルの座標を右側の値で除算します。
SFXPixelRef operator=( SFXPixelConstRef param )
左側のピクセルの座標に右側のピクセルの座標を代入します。
SFXPixel::AtomRec * atomic_cast( SFXPixel * param )
SFXPixel クラスを SFXPixel::AtomRec 構造体に型変換します。
SFXPixel::AtomRec const * atomic_cast( SFXPixel const * param )
SFXPixel クラスを SFXPixel::AtomRec 構造体に型変換します。
SFXPixel operator/( SFXPixelConstRef left , SInt16 right )
左側のピクセルの座標を右側の値で除算したピクセルの座標を返します。
Bool operator==( SFXPixelConstRef left , SFXPixelConstRef right )
左側のピクセルの座標が右側のピクセルの座標と等しいか判定します。
SFXPixel operator-( Void )
左側のピクセルの座標から右側の値を減算したピクセルの座標を返します。
SFXPixel operator-( SFXPixelConstRef left , SFXPixelConstRef right )
左側のピクセルの座標から右側の値を減算したピクセルの座標を返します。
SFXPixel operator-( SFXPixelConstRef left , SFXGridConstRef right )
左側のピクセルの座標から右側の値を減算したピクセルの座標を返します。
SFXPixel operator%( SFXPixelConstRef left , SInt16 right )
左側のピクセルの座標を右側の値で剰余したピクセルの座標を返します。
SFXPixel operator*( SFXPixelConstRef left , SInt16 right )
左側のピクセルの座標を右側の値で乗算したピクセルの座標を返します。
Bool operator!=( SFXPixelConstRef left , SFXPixelConstRef right )
左側のピクセルの座標が右側のピクセルの座標と異なるか判定します。
SFXPixel operator+( Void )
左側のピクセルの座標に右側の値を加算したピクセルの座標を返します。
SFXPixel operator+( SFXPixelConstRef left , SFXPixelConstRef right )
左側のピクセルの座標に右側の値を加算したピクセルの座標を返します。
SFXPixel operator+( SFXPixelConstRef left , SFXGridConstRef right )
左側のピクセルの座標に右側の値を加算したピクセルの座標を返します。
型
AtomRec
ピクセルを表す構造体です。
グローバル関数
SFXPixel::AtomRec * atomic_cast( SFXPixel * param )
SFXPixel クラスを SFXPixel::AtomRec 構造体に型変換します。
SFXPixel::AtomRec const * atomic_cast( SFXPixel const * param )
SFXPixel クラスを SFXPixel::AtomRec 構造体に型変換します。
SFXPixel operator/( SFXPixelConstRef left , SInt16 right )
左側のピクセルの座標を右側の値で除算したピクセルの座標を返します。
Bool operator==( SFXPixelConstRef left , SFXPixelConstRef right )
左側のピクセルの座標が右側のピクセルの座標と等しいか判定します。
SFXPixel operator-( Void )
左側のピクセルの座標から右側の値を減算したピクセルの座標を返します。
SFXPixel operator-( SFXPixelConstRef left , SFXPixelConstRef right )
左側のピクセルの座標から右側の値を減算したピクセルの座標を返します。
SFXPixel operator-( SFXPixelConstRef left , SFXGridConstRef right )
左側のピクセルの座標から右側の値を減算したピクセルの座標を返します。
SFXPixel operator%( SFXPixelConstRef left , SInt16 right )
左側のピクセルの座標を右側の値で剰余したピクセルの座標を返します。
SFXPixel operator*( SFXPixelConstRef left , SInt16 right )
左側のピクセルの座標を右側の値で乗算したピクセルの座標を返します。
Bool operator!=( SFXPixelConstRef left , SFXPixelConstRef right )
左側のピクセルの座標が右側のピクセルの座標と異なるか判定します。
SFXPixel operator+( Void )
左側のピクセルの座標に右側の値を加算したピクセルの座標を返します。
SFXPixel operator+( SFXPixelConstRef left , SFXPixelConstRef right )
左側のピクセルの座標に右側の値を加算したピクセルの座標を返します。
SFXPixel operator+( SFXPixelConstRef left , SFXGridConstRef right )
左側のピクセルの座標に右側の値を加算したピクセルの座標を返します。
SFXPixel::SFXPixel
SFXPixel クラスのコンストラクタです。
[ public, explicit ]
SFXPixel(Void);
[ public ]
SFXPixel(
    SFXPixelConstRef param   // 元になるピクセル
);
[ public, explicit ]
SFXPixel(
    SInt16 x   //  ピクセルの X 座標
    SInt16 y   //  ピクセルの Y 座標
);

解説

引数にが指定された場合、 このコンストラクタは、 内部的に SFXPixel::Set 関数を呼び出して指定された値でこのピクセルの座標を初期設定します。

参照

SFXPixel::Set | BREW API AEEPoint

SFXPixel::Add
このピクセルの座標に指定された値を加算します。
[ public ]
SFXPixelRef Add(
    SFXPixelConstRef param   // このピクセルの座標に加算する値
);
[ public ]
SFXPixelRef Add(
    SInt16 x   // このピクセルの X 座標に加算する値
    SInt16 y   // このピクセルの Y 座標に加算する値
);

戻り値

このピクセルの座標に指定された値を加算した後のこのピクセルの座標

解説

この関数は、このピクセルの座標に指定された値を加算します。

[Note] 注意

このピクセルの座標は指定された値を加算した分だけ移動します。

参照

SFXPixel::Offset | SFXPixel::AddX | SFXPixel::AddY | SFXPixel::Sub | SFXPixel::Mul | SFXPixel::Div | SFXPixel::Mod | SFXPixel::Neg

SFXPixel::AddX
このピクセルの X 座標に指定された値を加算します。
[ public ]
SFXPixelRef AddX(
    SInt16 param   // 加算する値
);

戻り値

このピクセルの X 座標に指定された値を加算した後のこのピクセルの座標

解説

この関数は、このピクセルの X 座標に指定された値を加算します。

[Note] 注意

このピクセルの座標は指定された値を加算した分だけ移動します。

参照

SFXPixel::Add | SFXPixel::AddY | SFXPixel::SubX | SFXPixel::MulX | SFXPixel::DivX | SFXPixel::ModX | SFXPixel::NegX

SFXPixel::AddY
このピクセルの Y 座標に指定された値を加算します。
[ public ]
SFXPixelRef AddY(
    SInt16 param   // 加算する値
);

戻り値

このピクセルの Y 座標に指定された値を加算した後のこのピクセルの座標

解説

この関数は、このピクセルの Y 座標に指定された値を加算します。

[Note] 注意

このピクセルの座標は指定された値を加算した分だけ移動します。

参照

SFXPixel::Add | SFXPixel::AddX | SFXPixel::SubY | SFXPixel::MulY | SFXPixel::DivY | SFXPixel::ModY | SFXPixel::NegY

SFXPixel::Div
このピクセルの座標を指定された値で除算します。
[ public ]
SFXPixelRef Div(
    SInt16 x   // このピクセルの X 座標を除算する値
    SInt16 y   // このピクセルの Y 座標を除算する値
);
[ public ]
SFXPixelRef Div(
    SInt16 param   // このピクセルの座標を除算する値
);

戻り値

このピクセルの座標を指定された値で除算した後のこのピクセルの座標

解説

この関数は、このピクセルの座標を指定された値で除算します。

x、y、または param 引数の値が 0 の場合の動作は未定義です。

[Note] 注意

このピクセルの座標は指定された値で除算した分だけ移動します。

参照

SFXPixel::Add | SFXPixel::Sub | SFXPixel::Mul | SFXPixel::DivX | SFXPixel::DivY | SFXPixel::Mod | SFXPixel::Neg | operator/ | SFXPixel::operator/=

SFXPixel::DivX
このピクセルの X 座標を指定された値で除算します。
[ public ]
SFXPixelRef DivX(
    SInt16 param   // 除算する値
);

戻り値

このピクセルの X 座標を指定された値で除算した後のこのピクセルの座標

解説

この関数は、このピクセルの X 座標を指定された値で除算します。

param 引数の値が 0 の場合の動作は未定義です。

[Note] 注意

このピクセルの座標は指定された値で除算した分だけ移動します。

参照

SFXPixel::AddX | SFXPixel::SubX | SFXPixel::MulX | SFXPixel::Div | SFXPixel::DivY | SFXPixel::ModX | SFXPixel::NegX

SFXPixel::DivY
このピクセルの Y 座標を指定された値で除算します。
[ public ]
SFXPixelRef DivY(
    SInt16 param   // 除算する値
);

戻り値

このピクセルの Y 座標を指定された値で除算した後のこのピクセルの座標

解説

この関数は、このピクセルの Y 座標を指定された値で除算します。

param 引数の値が 0 の場合の動作は未定義です。

[Note] 注意

このピクセルの座標は指定された値で除算した分だけ移動します。

参照

SFXPixel::AddY | SFXPixel::SubY | SFXPixel::MulY | SFXPixel::Div | SFXPixel::DivX | SFXPixel::ModY | SFXPixel::NegY

SFXPixel::Equals
このピクセルの座標が指定された値と等しいか判定します。
[ public, const ]
Bool Equals(
    SFXPixelConstRef param   // 比較対象のピクセル
);
[ public, const ]
Bool Equals(
    SInt16 x   // 比較対象のピクセルの X 座標
    SInt16 y   // 比較対象のピクセルの Y 座標
);

戻り値

  • 等しいとき: true
  • そうでないとき: false

解説

この関数は、このピクセルの座標が指定された値と等しいか判定します。

参照

operator== | operator!=

SFXPixel::GetBottom
このピクセルの右下端・左下端格子点の Y 座標を取得します。
[ public, const ]
SInt16 GetBottom(Void);

戻り値

このピクセルの右下端・左下端格子点の Y 座標

解説

この関数は、このピクセルの右下端・左下端格子点（上辺）の Y 座標を取得します。

参照

SFXPixel::SetBottom | SFXPixel::GetTop | SFXPixel::GetLeft | SFXPixel::GetRight | SFXPixel::GetLeftTop | SFXPixel::GetRightTop | SFXPixel::GetLeftBottom | SFXPixel::GetRightBottom

SFXPixel::GetLeft
このピクセルの左上端・左下端格子点の X 座標を取得します。
[ public, const ]
SInt16 GetLeft(Void);

戻り値

このピクセルの左上端・左下端格子点の X 座標

解説

この関数は、このピクセルの左上端・左下端格子点（左辺）の X 座標を取得します。

参照

SFXPixel::SetLeft | SFXPixel::GetTop | SFXPixel::GetBottom | SFXPixel::GetRight | SFXPixel::GetLeftTop | SFXPixel::GetRightTop | SFXPixel::GetLeftBottom | SFXPixel::GetRightBottom

SFXPixel::GetLeftBottom
このピクセルの左下端格子点の座標を取得します。
[ public, const ]
SFXGrid GetLeftBottom(Void);

戻り値

このピクセルの左下端格子点の座標

解説

この関数は、このピクセルの左下端格子点の座標を取得します。

参照

SFXPixel::SetLeftBottom | SFXPixel::GetBottom | SFXPixel::GetLeft

SFXPixel::GetLeftTop
このピクセルの左上端格子点の座標を取得します。
[ public, const ]
SFXGrid GetLeftTop(Void);

戻り値

このピクセルの左上端格子点の座標

解説

この関数は、このピクセルの左上端格子点の座標を取得します。

参照

SFXPixel::SetLeftTop | SFXPixel::GetTop | SFXPixel::GetLeft

SFXPixel::GetRight
このピクセルの右上端・右下端格子点の X 座標を取得します。
[ public, const ]
SInt16 GetRight(Void);

戻り値

このピクセルの右上端・右下端格子点の X 座標

解説

この関数は、このピクセルの右上端・右下端格子点（右辺）の X 座標を取得します。

参照

SFXPixel::SetRight | SFXPixel::GetTop | SFXPixel::GetBottom | SFXPixel::GetLeft | SFXPixel::GetLeftTop | SFXPixel::GetRightTop | SFXPixel::GetLeftBottom | SFXPixel::GetRightBottom

SFXPixel::GetRightBottom
このピクセルの右下端格子点の座標を取得します。
[ public, const ]
SFXGrid GetRightBottom(Void);

戻り値

このピクセルの右下端格子点の座標

解説

この関数は、このピクセルの右下端格子点の座標を取得します。

参照

SFXPixel::SetRightBottom | SFXPixel::GetBottom | SFXPixel::GetRight

SFXPixel::GetRightTop
このピクセルの右上端格子点の座標を取得します。
[ public, const ]
SFXGrid GetRightTop(Void);

戻り値

このピクセルの右上端格子点の座標

解説

この関数は、このピクセルの右上端格子点の座標を取得します。

参照

SFXPixel::SetRightTop | SFXPixel::GetTop | SFXPixel::GetLeft | SFXPixel::GetRight

SFXPixel::GetTop
このピクセルの右上端・左上端格子点の Y 座標を取得します。
[ public, const ]
SInt16 GetTop(Void);

戻り値

このピクセルの右上端・左上端格子点の Y 座標

解説

この関数は、このピクセルの右上端・左上端格子点（上辺）の Y 座標を取得します。

参照

SFXPixel::SetTop | SFXPixel::GetBottom | SFXPixel::GetLeft | SFXPixel::GetRight | SFXPixel::GetLeftTop | SFXPixel::GetRightTop | SFXPixel::GetLeftBottom | SFXPixel::GetRightBottom

SFXPixel::GetX
このピクセルの X 座標を取得します。
[ public, const ]
SInt16 GetX(Void);

戻り値

このピクセルの X 座標

解説

この関数は、このピクセルの X 座標を取得します。

参照

SFXPixel::SetX | SFXPixel::GetY

SFXPixel::GetY
このピクセルの Y 座標を取得します。
[ public, const ]
SInt16 GetY(Void);

戻り値

このピクセルの Y 座標

解説

この関数は、このピクセルの Y 座標を取得します。

参照

SFXPixel::SetY | SFXPixel::GetX

SFXPixel::IsInsideOf
このピクセルの座標が指定された矩形領域の中に含まれるか判定します。
[ public, const ]
Bool IsInsideOf(
    SFXRectangleConstRef param   // 基準となる矩形領域
);

戻り値

  • 含まれるとき: true
  • そうでないとき: false

解説

この関数は、このピクセルの座標が指定された矩形領域の中に含まれるか判定します。

[Note] 注意

矩形領域は辺の上も含みます。

SFXPixel::Mod
このピクセルの座標を指定された値で剰余します。
[ public ]
SFXPixelRef Mod(
    SInt16 x   // このピクセルの X 座標を剰余する値
    SInt16 y   // このピクセルの Y 座標を剰余する値
);
[ public ]
SFXPixelRef Mod(
    SInt16 param   // このピクセルの座標を剰余する値
);

戻り値

このピクセルの座標を指定された値で剰余した後のこのピクセルの座標

解説

この関数は、このピクセルの座標を指定された値で剰余します。

x、y、または param 引数の値が 0 の場合の動作は未定義です。

[Note] 注意

このピクセルの座標は指定された値で剰余した分だけ移動します。

参照

SFXPixel::ModX | SFXPixel::ModY | SFXPixel::Add | SFXPixel::Sub | SFXPixel::Mul | SFXPixel::Div | SFXPixel::Neg | operator% | SFXPixel::operator%=

SFXPixel::ModX
このピクセルの X 座標を指定された値で剰余します。
[ public ]
SFXPixelRef ModX(
    SInt16 param   // 剰余する値
);

戻り値

このピクセルの X 座標を指定された値で剰余した後のこのピクセルの座標

解説

この関数は、このピクセルの X 座標を指定された値で剰余します。

param 引数の値が 0 の場合の動作は未定義です。

[Note] 注意

このピクセルの座標は指定された値で剰余した分だけ移動します。

参照

SFXPixel::Mod | SFXPixel::ModY | SFXPixel::AddX | SFXPixel::SubX | SFXPixel::MulX | SFXPixel::DivX | SFXPixel::NegX

SFXPixel::ModY
このピクセルの Y 座標を指定された値で剰余します。
[ public ]
SFXPixelRef ModY(
    SInt16 param   // 剰余する値
);

戻り値

このピクセルの Y 座標を指定された値で剰余した後のこのピクセルの座標

解説

この関数は、このピクセルの Y 座標を指定された値で剰余します。

param 引数の値が 0 の場合の動作は未定義です。

[Note] 注意

このピクセルの座標は指定された値で剰余した分だけ移動します。

参照

SFXPixel::Mod | SFXPixel::ModX | SFXPixel::AddY | SFXPixel::SubY | SFXPixel::MulY | SFXPixel::DivY | SFXPixel::NegY

SFXPixel::Mul
このピクセルの座標に指定された値を乗算します。
[ public ]
SFXPixelRef Mul(
    SInt16 x   // このピクセルの X 座標に乗算する値
    SInt16 y   // このピクセルの Y 座標に乗算する値
);
[ public ]
SFXPixelRef Mul(
    SInt16 param   // このピクセルの座標に乗算する値
);

戻り値

このピクセルの座標に指定された値を乗算した後のこのピクセルの座標

解説

この関数は、このピクセルの座標に指定された値を乗算します。

[Note] 注意

このピクセルの座標は指定された値で乗算した分だけ移動します。

参照

SFXPixel::MulX | SFXPixel::MulY | SFXPixel::Add | SFXPixel::Sub | SFXPixel::Div | SFXPixel::Mod | SFXPixel::Neg | operator* | SFXPixel::operator*=

SFXPixel::MulX
このピクセルの X 座標に指定された値を乗算します。
[ public ]
SFXPixelRef MulX(
    SInt16 param   // 乗算する値
);

戻り値

このピクセルの X 座標に指定された値を乗算した後のこのピクセルの座標

解説

この関数は、このピクセルの X 座標に指定された値を乗算します。

[Note] 注意

このピクセルの座標は指定された値で乗算した分だけ移動します。

参照

SFXPixel::Mul | SFXPixel::MulY | SFXPixel::AddX | SFXPixel::SubX | SFXPixel::DivX | SFXPixel::ModX | SFXPixel::NegX

SFXPixel::MulY
このピクセルの Y 座標に指定された値を乗算します。
[ public ]
SFXPixelRef MulY(
    SInt16 param   // 乗算する値
);

戻り値

このピクセルの Y 座標に指定された値を乗算した後のこのピクセルの座標

解説

この関数は、このピクセルの Y 座標に指定された値を乗算します。

param 引数の値が 0 の場合の動作は未定義です。

[Note] 注意

このピクセルの座標は指定された値で乗算した分だけ移動します。

参照

SFXPixel::Mul | SFXPixel::MulX | SFXPixel::AddY | SFXPixel::SubY | SFXPixel::DivY | SFXPixel::ModY | SFXPixel::NegY

SFXPixel::Neg
このピクセルの座標の符号を反転します。
[ public ]
SFXPixelRef Neg(Void);

戻り値

このピクセルの座標（X 座標と Y 座標）の符号を反転させた後のこのピクセルの座標

解説

この関数は、このピクセルの座標（X 座標と Y 座標）の符号を反転します。

[Note] 注意

このピクセルの座標は符号を反転させた分だけ移動します。

参照

SFXPixel::NegX | SFXPixel::NegY | SFXPixel::Add | SFXPixel::Sub | SFXPixel::Mul | SFXPixel::Div | SFXPixel::Mod

SFXPixel::NegX
このピクセルの X 座標の符号を反転します。
[ public ]
SFXPixelRef NegX(Void);

戻り値

このピクセルの X 座標の符号を反転させた後のこのピクセルの座標

解説

この関数は、このピクセルの X 座標の符号を反転します。

[Note] 注意

このピクセルの座標は符号を反転させた分だけ移動します。

参照

SFXPixel::Neg | SFXPixel::NegY | SFXPixel::AddX | SFXPixel::SubX | SFXPixel::MulX | SFXPixel::DivX | SFXPixel::ModX

SFXPixel::NegY
このピクセルの Y 座標の符号を反転します。
[ public ]
SFXPixelRef NegY(Void);

戻り値

このピクセルの Y 座標の符号を反転させた後のこのピクセルの座標

解説

この関数は、このピクセルの Y 座標の符号を反転します。

[Note] 注意

このピクセルの座標は符号を反転させた分だけ移動します。

参照

SFXPixel::Neg | SFXPixel::NegX | SFXPixel::AddY | SFXPixel::SubY | SFXPixel::MulY | SFXPixel::DivY | SFXPixel::ModY

SFXPixel::Offset
このピクセルの座標に指定された値を加算します（このピクセルは、引数に指定された値に応じて移動します）。
[ public ]
SFXPixelRef Offset(
    SFXGridConstRef param   // このピクセルの座標に加算する値
);
[ public ]
SFXPixelRef Offset(
    SInt16 x   // このピクセルの X 座標に加算する値
    SInt16 y   // このピクセルの Y 座標に加算する値
);

戻り値

指定された値を加算した後のこのピクセルの座標

解説

この関数は、このピクセルの座標に指定された値を加算します。

[Note] 注意

このピクセルの座標は指定された値を加算した分だけ移動します。

参照

SFXPixel::Add | SFXPixel::Unoffset | operator+ | SFXPixel::operator+= | operator-

SFXPixel::Set
このピクセルの座標を指定された値に設定します。
[ public ]
SFXPixelRef Set(
    SFXPixelConstRef param   // コピー元のピクセル
);
[ public ]
SFXPixelRef Set(
    SInt16 x   // このピクセルの X 座標
    SInt16 y   // このピクセルの Y 座標
);

戻り値

設定後のこのピクセルの座標

解説

この関数は、このピクセルの座標（X 座標と Y 座標）を指定された値に設定します。

参照

SFXPixel::operator=

SFXPixel::SetBottom
右下端・左下端格子点の Y 座標を指定してこのピクセルの Y 座標を設定します。
[ public ]
SFXPixelRef SetBottom(
    SInt16 param   // 設定する値
);

戻り値

設定後のこのピクセルの座標

解説

この関数は、右下端・左下端格子点（下辺）の Y 座標を指定してこのピクセルの Y 座標を設定します。

参照

SFXPixel::GetBottom | SFXPixel::SetTop | SFXPixel::SetLeft | SFXPixel::SetRight | SFXPixel::SetLeftTop | SFXPixel::SetRightTop | SFXPixel::SetLeftBottom | SFXPixel::SetRightBottom

SFXPixel::SetLeft
左上端・左下端格子点の X 座標を指定してこのピクセルの X 座標を設定します。
[ public ]
SFXPixelRef SetLeft(
    SInt16 param   // 設定する値
);

戻り値

設定後のこのピクセルの座標

解説

この関数は、左上端・左下端格子点（左辺）の X 座標を指定してこのピクセルの X 座標を設定します。

参照

SFXPixel::GetLeft | SFXPixel::SetTop | SFXPixel::SetBottom | SFXPixel::SetRight | SFXPixel::SetLeftTop | SFXPixel::SetRightTop | SFXPixel::SetLeftBottom | SFXPixel::SetRightBottom

SFXPixel::SetLeftBottom
左下端格子点の座標を指定してこのピクセルの座標を設定します。
[ public ]
SFXPixelRef SetLeftBottom(
    SFXGridConstRef param   // このピクセルの左下端格子点の座標
);
[ public ]
SFXPixelRef SetLeftBottom(
    SInt16 x   // このピクセルの左下端格子点の X 座標
    SInt16 y   // このピクセルの左下端格子点の Y 座標
);

戻り値

設定後のこのピクセルの座標

解説

この関数は、左下端格子点の座標を指定してこのピクセルの座標を設定します。

参照

SFXPixel::GetLeftBottom | SFXPixel::SetBottom | SFXPixel::SetLeft

SFXPixel::SetLeftTop
左上端格子点の座標を指定してこのピクセルの座標を設定します。
[ public ]
SFXPixelRef SetLeftTop(
    SFXGridConstRef param   // このピクセルの左上端格子点の座標
);
[ public ]
SFXPixelRef SetLeftTop(
    SInt16 x   // このピクセルの左上端格子点の X 座標
    SInt16 y   // このピクセルの左上端格子点の Y 座標
);

戻り値

設定後のこのピクセルの座標

解説

この関数は、左上端格子点の座標を指定してこのピクセルの座標を設定します。

参照

SFXPixel::GetLeftTop | SFXPixel::SetTop | SFXPixel::SetLeft

SFXPixel::SetRight
右上端・右下端格子点の X 座標を指定してこのピクセルの X 座標を設定します。
[ public ]
SFXPixelRef SetRight(
    SInt16 param   // 設定する値
);

戻り値

設定後のこのピクセルの座標

解説

この関数は、右上端・右下端格子点（右辺）の X 座標を指定してこのピクセルの X 座標を設定します。

参照

SFXPixel::GetRight | SFXPixel::SetTop | SFXPixel::SetBottom | SFXPixel::SetLeft | SFXPixel::SetLeftTop | SFXPixel::SetRightTop | SFXPixel::SetLeftBottom | SFXPixel::SetRightBottom

SFXPixel::SetRightBottom
右下端格子点の座標を指定してこのピクセルの座標を設定します。
[ public ]
SFXPixelRef SetRightBottom(
    SFXGridConstRef param   // このピクセルの右下端格子点の座標
);
[ public ]
SFXPixelRef SetRightBottom(
    SInt16 x   // このピクセルの右下端格子点の X 座標
    SInt16 y   // このピクセルの右下端格子点の Y 座標
);

戻り値

設定後のこのピクセルの座標

解説

この関数は、右下端格子点の座標を指定してこのピクセルの座標を設定します。

参照

SFXPixel::GetRightBottom | SFXPixel::SetBottom | SFXPixel::SetRight

SFXPixel::SetRightTop
右上端格子点の座標を指定してこのピクセルの座標を設定します。
[ public ]
SFXPixelRef SetRightTop(
    SFXGridConstRef param   // このピクセルの右上端格子点の座標
);
[ public ]
SFXPixelRef SetRightTop(
    SInt16 x   // このピクセルの右上端格子点の X 座標
    SInt16 y   // このピクセルの右上端格子点の Y 座標
);

戻り値

設定後のこのピクセルの座標

解説

この関数は、右上端格子点の座標を指定してこのピクセルの座標を設定します。

参照

SFXPixel::GetRightTop | SFXPixel::SetTop | SFXPixel::SetLeft | SFXPixel::SetRight

SFXPixel::SetTop
右上端・左上端格子点の Y 座標を指定してこのピクセルの Y 座標を設定します。
[ public ]
SFXPixelRef SetTop(
    SInt16 param   // 設定する値
);

戻り値

設定後のこのピクセルの座標

解説

この関数は、右上端・左上端格子点（上辺）の Y 座標を指定してこのピクセルの Y 座標を設定します。

参照

SFXPixel::GetTop | SFXPixel::SetBottom | SFXPixel::SetLeft | SFXPixel::SetRight | SFXPixel::SetLeftTop | SFXPixel::SetRightTop | SFXPixel::SetLeftBottom | SFXPixel::SetRightBottom

SFXPixel::SetX
このピクセルの X 座標を指定された値に設定します。
[ public ]
SFXPixelRef SetX(
    SInt16 param   // 設定する値
);

戻り値

設定後のこのピクセルの座標

解説

この関数は、このピクセルの X 座標を指定された値に設定します。

参照

SFXPixel::GetX | SFXPixel::Set | SFXPixel::SetY

SFXPixel::SetY
このピクセルの Y 座標を指定された値に設定します。
[ public ]
SFXPixelRef SetY(
    SInt16 param   // 設定する値
);

戻り値

設定後のこのピクセルの座標

解説

この関数は、このピクセルの Y 座標を指定された値に設定します。

参照

SFXPixel::GetY | SFXPixel::Set | SFXPixel::SetX

SFXPixel::Sub
このピクセルの座標から指定された値を減算します。
[ public ]
SFXPixelRef Sub(
    SFXPixelConstRef param   // このピクセルの座標から減算する値
);
[ public ]
SFXPixelRef Sub(
    SInt16 x   // このピクセルの X 座標から減算する値
    SInt16 y   // このピクセルの Y 座標から減算する値
);

戻り値

このピクセルの座標から指定された値を減算した後のこのピクセルの座標

解説

この関数は、このピクセルの座標から指定された値を減算します。

[Note] 注意

このピクセルの座標は指定された値を減算した分だけ移動します。

参照

SFXPixel::Unoffset | SFXPixel::Add | SFXPixel::SubX | SFXPixel::SubY | SFXPixel::Mul | SFXPixel::Div | SFXPixel::Mod | SFXPixel::Neg

SFXPixel::SubX
このピクセルの X 座標から指定された値を減算します。
[ public ]
SFXPixelRef SubX(
    SInt16 param   // 減算する値
);

戻り値

このピクセルの X 座標から指定された値を減算した後のこのピクセルの座標

解説

この関数は、このピクセルの X 座標から指定された値を減算します。

[Note] 注意

このピクセルの座標は指定された値を減算した分だけ移動します。

参照

SFXPixel::AddX | SFXPixel::Sub | SFXPixel::SubY | SFXPixel::MulX | SFXPixel::DivX | SFXPixel::ModX | SFXPixel::NegX

SFXPixel::SubY
このピクセルの Y 座標から指定された値を減算します。
[ public ]
SFXPixelRef SubY(
    SInt16 param   // 減算する値
);

戻り値

このピクセルの Y 座標から指定された値を減算した後のこのピクセルの座標

解説

この関数は、このピクセルの Y 座標から指定された値を減算します。

[Note] 注意

このピクセルの座標は指定された値を減算した分だけ移動します。

参照

SFXPixel::AddY | SFXPixel::Sub | SFXPixel::SubX | SFXPixel::MulY | SFXPixel::DivY | SFXPixel::ModY | SFXPixel::NegY

SFXPixel::Unoffset
このピクセルの座標から指定された値を減算します（このピクセルは、引数に指定された値に応じて移動します）。
[ public ]
SFXPixelRef Unoffset(
    SFXGridConstRef param   // このピクセルの座標から減算する値
);
[ public ]
SFXPixelRef Unoffset(
    SInt16 x   // このピクセルの X 座標から減算する値
    SInt16 y   // このピクセルの Y 座標から減算する値
);

戻り値

指定された値を減算した後のこのピクセルの座標

解説

この関数は、このピクセルの座標から指定された値を減算します。

[Note] 注意

このピクセルの座標は指定された値を減算した分だけ移動します。

参照

SFXPixel::Sub | SFXPixel::Offset | operator- | SFXPixel::operator-= | operator+

SFXPixel::ZeroInstance
0 を表す SFXPixel インスタンスを取得します。
[ public, static ]
SFXPixelConstRef ZeroInstance(Void);

戻り値

0 を表す SFXPixel インスタンス

解説

この関数は、0 を表す SFXPixel インスタンスを返します。

具体的には、SFXPixel::AtomRec 構造体のメンバ変数である、 X 座標と Y 座標が 0 に設定された SFXPixel インスタンスを返します。

[Note] 0 を表すインスタンスとは

0 を表すインスタンスとは、 対応する AtomRec 構造体のすべてのメンバ変数が 0 または null に設定されたインスタンスのことです。

使用例

SFXPixel pixel(10, 20);

pixel = SFXPixel::ZeroInstance();  // pixel を初期化する
TRACE("x = %d, y = %d", pixel.GetX(), pixel.GetY());  // x = 0, y = 0

参照

SFXPixel::AtomRec

atomic_cast
SFXPixel クラスを SFXPixel::AtomRec 構造体に型変換します。
[ public, friend ]
SFXPixel::AtomRec * atomic_cast(
    SFXPixel * param   // キャストするピクセル座標
);
[ public, friend ]
SFXPixel::AtomRec const * atomic_cast(
    SFXPixel const * param   // キャストするピクセル座標
);

解説

この関数は、SFXPixel クラスを SFXPixel::AtomRec 構造体に型変換します。

参照

SFXPixel::AtomRec

SFXPixel::operator=
左側のピクセルの座標に右側のピクセルの座標を代入します。
[ public ]
SFXPixelRef operator=(
    SFXPixelConstRef param   // 右側のピクセルの座標
);

戻り値

右側のピクセルの座標を代入した後の左側のピクセルの座標

解説

このオペレーターは、左側のピクセルの座標に右側のピクセルの座標を代入します。

参照

SFXPixel::Set

SFXPixel::operator/=
左側のピクセルの座標を右側の値で除算します。
[ public ]
SFXPixelRef operator/=(
    SInt16 param   // 右側の値
);

戻り値

右側の値で除算した後の左側のピクセルの座標

解説

このオペレーターは、左側のピクセルの座標を右側の値で除算します。

param 引数の値が 0 の場合の動作は未定義です。

[Note] 注意

左側のピクセルの座標は右側の値で除算した分だけ移動します。

参照

SFXPixel::Div | operator/ | SFXPixel::operator*= | SFXPixel::operator%=

operator/
左側のピクセルの座標を右側の値で除算したピクセルの座標を返します。
[ public, friend ]
SFXPixel operator/(
    SFXPixelConstRef left   // 左側のピクセルの座標
    SInt16 right            // 右側の値
);

戻り値

左側のピクセルの座標を右側の値で除算したピクセルの座標

解説

このオペレーターは、左側のピクセルの座標を右側の値で除算したピクセルの座標を返します。

right 引数の値が 0 の場合の動作は未定義です。

[Note] 注意

戻り値のピクセルの座標は、左側のピクセルの座標よりも右側の値で除算した分だけ移動します。

参照

SFXPixel::Div | SFXPixel::operator/= | operator* | operator%

operator==
左側のピクセルの座標が右側のピクセルの座標と等しいか判定します。
[ public, friend ]
Bool operator==(
    SFXPixelConstRef left    // 左側のピクセルの座標
    SFXPixelConstRef right   // 右側のピクセルの座標
);

戻り値

  • 等しいとき: true
  • そうでないとき: false

解説

このオペレーターは、左側のピクセルの座標が右側のピクセルの座標と等しいか判定します。

参照

SFXPixel::Equals | operator!=

SFXPixel::operator-=
左側のピクセルの座標から右側の値を減算します。
[ public ]
SFXPixelRef operator-=(
    SFXPixelConstRef param   // 右側のピクセルの座標
);
[ public ]
SFXPixelRef operator-=(
    SFXGridConstRef param   // 右側の格子点の座標
);

戻り値

右側の値を減算した後の左側のピクセルの座標

解説

このオペレーターは、左側のピクセルの座標から右側の値を減算します。

[Note] 注意

左側のピクセルの座標は右側の値を減算した分だけ移動します。

参照

SFXPixel::Unoffset | SFXPixel::Sub | operator- | SFXPixel::operator+=

operator-
左側のピクセルの座標から右側の値を減算したピクセルの座標を返します。
[ public, const ]
SFXPixel operator-(Void);
[ public, friend ]
SFXPixel operator-(
    SFXPixelConstRef left    // 左側のピクセルの座標
    SFXPixelConstRef right   // 右側のピクセルの座標
);
[ public, friend ]
SFXPixel operator-(
    SFXPixelConstRef left   // 左側のピクセルの座標
    SFXGridConstRef right   // 右側の格子点の座標
);

戻り値

左側のピクセルの座標から右側の値を減算したピクセルの座標

解説

このオペレーターは、左側のピクセルの座標から右側の値を減算したピクセルの座標を返します。

このオペレーターが単項演算子の場合は（operator- の引数が Void 型のとき）、 オペランドのピクセルの座標（X 座標と Y 座標）の符号を反転させた座標を返します。

[Note] 注意

戻り値のピクセルの座標は、左側のピクセルの座標よりも右側の値を減算した分だけ移動します。

参照

SFXPixel::Unoffset | SFXPixel::Sub | SFXPixel::operator-= | operator+

SFXPixel::operator%=
左側のピクセルの座標を右側の値で剰余します。
[ public ]
SFXPixelRef operator%=(
    SInt16 param   // 右側の値
);

戻り値

右側の値で剰余した後の左側のピクセルの座標

解説

このオペレーターは、左側のピクセルの座標を右側の値で剰余します。

param 引数の値が 0 の場合の動作は未定義です。

[Note] 注意

左側のピクセルの座標は右側の値で剰余した分だけ移動します。

参照

SFXPixel::Mod | SFXPixel::operator/= | SFXPixel::operator*= | operator%

operator%
左側のピクセルの座標を右側の値で剰余したピクセルの座標を返します。
[ public, friend ]
SFXPixel operator%(
    SFXPixelConstRef left   // 左側のピクセルの座標
    SInt16 right            // 右側の値
);

戻り値

左側のピクセルの座標を右側の値で剰余したピクセルの座標

解説

このオペレーターは、左側のピクセルの座標を右側の値で剰余したピクセルの座標を返します。

right 引数の値が 0 の場合の動作は未定義です。

[Note] 注意

戻り値のピクセルの座標は、左側のピクセルの座標よりも右側の値で剰余した分だけ移動します。

参照

SFXPixel::Mod | operator/ | operator* | SFXPixel::operator%=

SFXPixel::operator*=
左側のピクセルの座標を右側の値で乗算します。
[ public ]
SFXPixelRef operator*=(
    SInt16 param   // 右側の値
);

戻り値

右側の値で乗算した後の左側のピクセルの座標

解説

このオペレーターは、左側のピクセルの座標を右側の値で乗算します。

[Note] 注意

左側のピクセルの座標は右側の値で乗算した分だけ移動します。

参照

SFXPixel::Mul | SFXPixel::operator/= | operator* | SFXPixel::operator%=

operator*
左側のピクセルの座標を右側の値で乗算したピクセルの座標を返します。
[ public, friend ]
SFXPixel operator*(
    SFXPixelConstRef left   // 左側のピクセルの座標
    SInt16 right            // 右側の値
);

戻り値

左側のピクセルの座標を右側の値で乗算したピクセルの座標

解説

このオペレーターは、左側のピクセルの座標を右側の値で乗算したピクセルの座標を返します。

[Note] 注意

戻り値のピクセルの座標は、左側のピクセルの座標よりも右側の値で乗算した分だけ移動します。

参照

SFXPixel::Mul | operator/ | SFXPixel::operator*= | operator%

operator!=
左側のピクセルの座標が右側のピクセルの座標と異なるか判定します。
[ public, friend ]
Bool operator!=(
    SFXPixelConstRef left    // 左側のピクセルの座標
    SFXPixelConstRef right   // 右側のピクセルの座標
);

戻り値

  • 異なるとき: true
  • そうでないとき: false

解説

このオペレーターは、左側のピクセルの座標が右側のピクセルの座標と異なるか判定します。

参照

SFXPixel::Equals | operator==

SFXPixel::operator+=
左側のピクセルの座標に右側の値を加算します。
[ public ]
SFXPixelRef operator+=(
    SFXPixelConstRef param   // 右側のピクセルの座標
);
[ public ]
SFXPixelRef operator+=(
    SFXGridConstRef param   // 右側の格子点の座標
);

戻り値

右側の値を加算した後の左側のピクセルの座標

解説

このオペレーターは、左側のピクセルの座標に右側の値を加算します。

[Note] 注意

左側のピクセルの座標は右側の値を加算した分だけ移動します。

参照

SFXPixel::Offset | SFXPixel::operator-= | operator+

operator+
左側のピクセルの座標に右側の値を加算したピクセルの座標を返します。
[ public, const ]
SFXPixel operator+(Void);
[ public, friend ]
SFXPixel operator+(
    SFXPixelConstRef left    // 左側のピクセルの座標
    SFXPixelConstRef right   // 右側のピクセルの座標
);
[ public, friend ]
SFXPixel operator+(
    SFXPixelConstRef left   // 左側のピクセルの座標
    SFXGridConstRef right   // 右側の格子点の座標
);

戻り値

左側のピクセルの座標に右側の値を加算したピクセルの座標

解説

このオペレーターは、左側のピクセルの座標に右側の値を加算したピクセルの座標を返します。

このオペレーターが単項演算子の場合は（operator+ の引数が Void 型のとき）、オペランドのピクセルの座標をそのまま返します。

[Note] 注意

戻り値のピクセルの座標は、左側のピクセルの座標よりも右側の値を加算した分だけ移動します。

参照

SFXPixel::Offset | operator- | SFXPixel::operator+=

SFXPixel::AtomRec
ピクセルを表す構造体です。 
struct AtomRec {
  SInt16  x;  // X 座標
  SInt16  y;  // Y 座標
};

参照

BREW API AEEPoint

Copyright(c) 2002 - 2024
Sophia Cradle Incorporated
All Rights Reserved. 		前のページ次のページ上に戻るホーム