前のページ次のページ上に戻るホーム SophiaFramework UNIVERSE 5.3
SFXSize
サイズ(幅と高さ)を表すクラスです。
#include <SFXSize.h.hpp>
class SFXSize;
SFMTYPEDEFCLASS(SFXSize)

解説

SFXSize クラスは、サイズ(幅と高さ)を表すクラスです。

SFXSize::AtomRec 構造体はサイズを表す構造体であり、 幅と高さを持ちます。

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

参照

SFXSize::AtomRec | BREW API AEESize

メンバ

コンストラクタ/デストラクタ
SFXSize( Void )
SFXSize クラスのコンストラクタです。
SFXSize( SFXSizeConstRef param )
SFXSize クラスのコンストラクタです。
SFXSize( SInt16 width , SInt16 height )
SFXSize クラスのコンストラクタです。
SFXSize( SFXGridConstRef grid )
SFXSize クラスのコンストラクタです。
パブリック関数
SFXSizeRef Add( SFXSizeConstRef param )
このサイズに指定された値を加算します。
SFXSizeRef Add( SInt16 width , SInt16 height )
このサイズに指定された値を加算します。
SFXSizeRef Add( SFXGridConstRef grid )
このサイズに指定された値を加算します。
SFXSizeRef AddHeight( SInt16 param )
このサイズの高さに指定された値を加算します。
SFXSizeRef AddWidth( SInt16 param )
このサイズの幅に指定された値を加算します。
SFXSizeRef Div( SInt16 width , SInt16 height )
このサイズを指定された値で除算します。
SFXSizeRef Div( SInt16 param )
このサイズを指定された値で除算します。
SFXSizeRef DivHeight( SInt16 param )
このサイズの高さを指定された値で除算します。
SFXSizeRef DivWidth( SInt16 param )
このサイズの幅を指定された値で除算します。
static
SFXSizeConstRef
EmptyInstance( Void )
空のサイズを取得します。
Bool Equals( SFXSizeConstRef param )
このサイズが指定された値と等しいか判定します。
Bool Equals( SInt16 width , SInt16 height )
このサイズが指定された値と等しいか判定します。
Bool Equals( SFXGridConstRef grid )
このサイズが指定された値と等しいか判定します。
SInt16 GetHeight( Void )
このサイズの高さを取得します。
SInt16 GetWidth( Void )
このサイズの幅を取得します。
Bool IsEmpty( Void )
このサイズが空であるか判定します。
SFXSizeRef Mod( SInt16 width , SInt16 height )
このサイズを指定された値で剰余します。
SFXSizeRef Mod( SInt16 param )
このサイズを指定された値で剰余します。
SFXSizeRef ModHeight( SInt16 param )
このサイズの高さを指定された値で剰余します。
SFXSizeRef ModWidth( SInt16 param )
このサイズの幅を指定された値で剰余します。
SFXSizeRef Mul( SInt16 width , SInt16 height )
このサイズに指定された値を乗算します。
SFXSizeRef Mul( SInt16 param )
このサイズに指定された値を乗算します。
SFXSizeRef MulHeight( SInt16 param )
このサイズの高さに指定された値を乗算します。
SFXSizeRef MulWidth( SInt16 param )
このサイズの幅に指定された値を乗算します。
SFXSizeRef Neg( Void )
このサイズの符号を反転します。
SFXSizeRef NegHeight( Void )
このサイズの高さの符号を反転します。
SFXSizeRef NegWidth( Void )
このサイズの幅の符号を反転します。
SFXSizeRef Normalize( Void )
このサイズを正規化します。
SFXSizeRef Set( SFXSizeConstRef param )
このサイズを指定された値に設定します。
SFXSizeRef Set( SInt16 width , SInt16 height )
このサイズを指定された値に設定します。
SFXSizeRef Set( SFXGridConstRef grid )
このサイズを指定された値に設定します。
SFXSizeRef SetHeight( SInt16 param )
このサイズの高さを指定された値に設定します。
SFXSizeRef SetWidth( SInt16 param )
このサイズの幅を指定された値に設定します。
SFXSizeRef Sub( SFXSizeConstRef param )
このサイズから指定された値を減算します。
SFXSizeRef Sub( SInt16 width , SInt16 height )
このサイズから指定された値を減算します。
SFXSizeRef Sub( SFXGridConstRef grid )
このサイズから指定された値を減算します。
SFXSizeRef SubHeight( SInt16 param )
このサイズの高さから指定された値を減算します。
SFXSizeRef SubWidth( SInt16 param )
このサイズの幅から指定された値を減算します。
static
SFXSizeConstRef
ZeroInstance( Void )
0 を表す SFXSize インスタンスを取得します。
SFXSizeRef operator%=( SInt16 param )
左側のサイズを右側の値で剰余します。
SFXSizeRef operator*=( SInt16 param )
左側のサイズを右側の値で乗算します。
SFXSizeRef operator+=( SFXSizeConstRef param )
左側のサイズに右側の値を加算します。
SFXSizeRef operator+=( SFXGridConstRef grid )
左側のサイズに右側の値を加算します。
SFXSizeRef operator-=( SFXSizeConstRef param )
左側のサイズから右側の値を減算します。
SFXSizeRef operator-=( SFXGridConstRef grid )
左側のサイズから右側の値を減算します。
SFXSizeRef operator/=( SInt16 param )
左側のサイズを右側の値で除算します。
SFXSizeRef operator=( SFXSizeConstRef param )
左側のサイズに右側の値を代入します。
SFXSizeRef operator=( SFXGridConstRef grid )
左側のサイズに右側の値を代入します。
SFXSize::AtomRec * atomic_cast( SFXSize * param )
SFXSize クラスを SFXSize::AtomRec 構造体に型変換します。
SFXSize::AtomRec const * atomic_cast( SFXSize const * param )
SFXSize クラスを SFXSize::AtomRec 構造体に型変換します。
SFXSize operator/( SFXSizeConstRef left , SInt16 right )
左側のサイズを右側の値で除算したサイズを返します。
Bool operator==( SFXSizeConstRef left , SFXSizeConstRef right )
左側のサイズが右側の値と等しいか判定します。
Bool operator==( SFXSizeConstRef left , SFXGridConstRef right )
左側のサイズが右側の値と等しいか判定します。
SFXSize operator-( Void )
左側のサイズから右側の値を減算したサイズを返します。
SFXSize operator-( SFXSizeConstRef left , SFXSizeConstRef right )
左側のサイズから右側の値を減算したサイズを返します。
SFXSize operator-( SFXSizeConstRef left , SFXGridConstRef right )
左側のサイズから右側の値を減算したサイズを返します。
SFXSize operator%( SFXSizeConstRef left , SInt16 right )
左側のサイズを右側の値で剰余したサイズを返します。
SFXSize operator*( SFXSizeConstRef left , SInt16 right )
左側のサイズを右側の値で乗算したサイズを返します。
Bool operator!=( SFXSizeConstRef left , SFXSizeConstRef right )
左側のサイズが右側の値と異なるか判定します。
Bool operator!=( SFXSizeConstRef left , SFXGridConstRef right )
左側のサイズが右側の値と異なるか判定します。
SFXSize operator+( Void )
左側のサイズに右側の値を加算したサイズを返します。
SFXSize operator+( SFXSizeConstRef left , SFXSizeConstRef right )
左側のサイズに右側の値を加算したサイズを返します。
SFXSize operator+( SFXSizeConstRef left , SFXGridConstRef right )
左側のサイズに右側の値を加算したサイズを返します。
AtomRec
サイズを表す構造体です。
グローバル関数
SFXSize::AtomRec * atomic_cast( SFXSize * param )
SFXSize クラスを SFXSize::AtomRec 構造体に型変換します。
SFXSize::AtomRec const * atomic_cast( SFXSize const * param )
SFXSize クラスを SFXSize::AtomRec 構造体に型変換します。
SFXSize operator/( SFXSizeConstRef left , SInt16 right )
左側のサイズを右側の値で除算したサイズを返します。
Bool operator==( SFXSizeConstRef left , SFXSizeConstRef right )
左側のサイズが右側の値と等しいか判定します。
Bool operator==( SFXSizeConstRef left , SFXGridConstRef right )
左側のサイズが右側の値と等しいか判定します。
SFXSize operator-( Void )
左側のサイズから右側の値を減算したサイズを返します。
SFXSize operator-( SFXSizeConstRef left , SFXSizeConstRef right )
左側のサイズから右側の値を減算したサイズを返します。
SFXSize operator-( SFXSizeConstRef left , SFXGridConstRef right )
左側のサイズから右側の値を減算したサイズを返します。
SFXSize operator%( SFXSizeConstRef left , SInt16 right )
左側のサイズを右側の値で剰余したサイズを返します。
SFXSize operator*( SFXSizeConstRef left , SInt16 right )
左側のサイズを右側の値で乗算したサイズを返します。
Bool operator!=( SFXSizeConstRef left , SFXSizeConstRef right )
左側のサイズが右側の値と異なるか判定します。
Bool operator!=( SFXSizeConstRef left , SFXGridConstRef right )
左側のサイズが右側の値と異なるか判定します。
SFXSize operator+( Void )
左側のサイズに右側の値を加算したサイズを返します。
SFXSize operator+( SFXSizeConstRef left , SFXSizeConstRef right )
左側のサイズに右側の値を加算したサイズを返します。
SFXSize operator+( SFXSizeConstRef left , SFXGridConstRef right )
左側のサイズに右側の値を加算したサイズを返します。

SFXSize::SFXSize
SFXSize クラスのコンストラクタです。
[ public, explicit ]
SFXSize(Void);
[ public ]
SFXSize(
    SFXSizeConstRef param   // 元になるサイズ ( SFXSize )
);
[ public, explicit ]
SFXSize(
    SInt16 width    // 幅
    SInt16 height   // 高さ
);
[ public, explicit ]
SFXSize(
    SFXGridConstRef grid   // 元になるサイズ ( SFXGrid )
);

解説

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

参照

SFXSize::Set


SFXSize::Add
このサイズに指定された値を加算します。
[ public ]
SFXSizeRef Add(
    SFXSizeConstRef param   // 幅と高さに加算する値 ( SFXSize )
);
[ public ]
SFXSizeRef Add(
    SInt16 width    // 幅に加算する値
    SInt16 height   // 高さに加算する値
);
[ public ]
SFXSizeRef Add(
    SFXGridConstRef grid   // 幅と高さに加算する値 ( SFXGrid )
);

戻り値

このサイズに指定された値を加算した後のこのサイズ

解説

この関数は、このサイズに指定された値を加算します。

[Note] 注意

このサイズは指定された値を加算した分だけ拡大しています。

[Note] 注意

指定された値が SFXGrid クラスの場合、 SFXGrid クラスの X 座標と Y 座標をそれぞれ SFXSize クラスの幅と高さと解釈します。

参照

SFXSize::AddWidth | SFXSize::AddHeight | SFXSize::Sub | SFXSize::Mul | SFXSize::Div | SFXSize::Mod | SFXSize::Neg | operator+ | SFXSize::operator+=


SFXSize::AddHeight
このサイズの高さに指定された値を加算します。
[ public ]
SFXSizeRef AddHeight(
    SInt16 param   // 加算する値
);

戻り値

このサイズの高さに指定された値を加算した後のこのサイズ

解説

この関数は、このサイズの高さに指定された値を加算します。

[Note] 注意

このサイズは指定された値を加算した分だけ拡大しています。

参照

SFXSize::Add | SFXSize::AddWidth | SFXSize::SubHeight | SFXSize::MulHeight | SFXSize::DivHeight | SFXSize::ModHeight | SFXSize::NegHeight


SFXSize::AddWidth
このサイズの幅に指定された値を加算します。
[ public ]
SFXSizeRef AddWidth(
    SInt16 param   // 加算する値
);

戻り値

このサイズの幅に指定された値を加算した後のこのサイズ

解説

この関数は、このサイズの幅に指定された値を加算します。

[Note] 注意

このサイズは指定された値を加算した分だけ拡大しています。

参照

SFXSize::Add | SFXSize::AddHeight | SFXSize::SubWidth | SFXSize::MulWidth | SFXSize::DivWidth | SFXSize::ModWidth | SFXSize::NegWidth


SFXSize::Div
このサイズを指定された値で除算します。
[ public ]
SFXSizeRef Div(
    SInt16 width    // 幅を除算する値
    SInt16 height   // 高さを除算する値
);
[ public ]
SFXSizeRef Div(
    SInt16 param   // 幅と高さを除算する値
);

戻り値

このサイズを指定された値で除算した後のこのサイズ

解説

この関数は、このサイズを指定された値で除算します。

[Note] 注意

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

参照

SFXSize::DivWidth | SFXSize::DivHeight | SFXSize::Add | SFXSize::Sub | SFXSize::Mul | SFXSize::Mod | SFXSize::Neg | operator/ | SFXSize::operator/=


SFXSize::DivHeight
このサイズの高さを指定された値で除算します。
[ public ]
SFXSizeRef DivHeight(
    SInt16 param   // 除算する値
);

戻り値

このサイズの高さを指定された値で除算した後のこのサイズ

解説

この関数は、このサイズの高さを指定された値で除算します。

[Note] 注意

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

参照

SFXSize::Div | SFXSize::DivWidth | SFXSize::AddHeight | SFXSize::SubHeight | SFXSize::MulHeight | SFXSize::ModHeight | SFXSize::NegHeight


SFXSize::DivWidth
このサイズの幅を指定された値で除算します。
[ public ]
SFXSizeRef DivWidth(
    SInt16 param   // 除算する値
);

戻り値

このサイズの幅を指定された値で除算した後のこのサイズ

解説

この関数は、このサイズの幅を指定された値で除算します。

[Note] 注意

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

参照

SFXSize::Div | SFXSize::DivHeight | SFXSize::AddWidth | SFXSize::SubWidth | SFXSize::MulWidth | SFXSize::ModWidth | SFXSize::NegWidth


SFXSize::EmptyInstance
空のサイズを取得します。
[ public, static ]
SFXSizeConstRef EmptyInstance(Void);

戻り値

面積 0 を表す SFXSize インスタンス

解説

この関数は、空のサイズ(面積 0 のサイズ)を取得します。

[Note] 注意

SFXSize::AtomRec 構造体のメンバ変数である、 幅または高さが 0 以下のとき、サイズの面積は 0 になります。

[Note] 注意

この関数の戻り値は、SFXSize::ZeroInstance 関数の戻り値と同じです。

参照

SFXSize::IsEmpty SFXSize::AtomRec | SFXSize::ZeroInstance


SFXSize::Equals
このサイズが指定された値と等しいか判定します。
[ public, const ]
Bool Equals(
    SFXSizeConstRef param   // 比較対象のサイズ ( SFXSize )
);
[ public, const ]
Bool Equals(
    SInt16 width    // 比較対象のサイズの横幅
    SInt16 height   // 比較対象のサイズの高さ
);
[ public, const ]
Bool Equals(
    SFXGridConstRef grid   // 比較対象のサイズ ( SFXGrid )
);

戻り値

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

解説

この関数は、このサイズが指定された値と等しいか判定します。

参照

operator== | operator!=


SFXSize::GetHeight
このサイズの高さを取得します。
[ public, const ]
SInt16 GetHeight(Void);

戻り値

このサイズの高さ

解説

この関数は、このサイズの高さを取得します。

参照

SFXSize::SetHeight | SFXSize::GetWidth


SFXSize::GetWidth
このサイズの幅を取得します。
[ public, const ]
SInt16 GetWidth(Void);

戻り値

このサイズの幅

解説

この関数は、このサイズの幅を取得します。

参照

SFXSize::SetWidth | SFXSize::GetHeight


SFXSize::IsEmpty
このサイズが空であるか判定します。
[ public, const ]
Bool IsEmpty(Void);

戻り値

  • 空のとき: true
  • そうでないとき: false

解説

この関数は、このサイズが空であるか判定します。

SFXSize::AtomRec 構造体のメンバ変数である、 幅または高さが 0 以下のとき、true を返します。

参照

SFXSize::Normalize | SFXSize::EmptyInstance | SFXSize::ZeroInstance | SFXSize::AtomRec


SFXSize::Mod
このサイズを指定された値で剰余します。
[ public ]
SFXSizeRef Mod(
    SInt16 width    // 幅を剰余する値
    SInt16 height   // 高さを剰余する値
);
[ public ]
SFXSizeRef Mod(
    SInt16 param   // 幅と高さを剰余する値
);

戻り値

このサイズを指定された値で剰余した後のこのサイズ

解説

この関数は、このサイズを指定された値で剰余します。

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

参照

SFXSize::ModWidth | SFXSize::ModHeight | SFXSize::Add | SFXSize::Sub | SFXSize::Mul | SFXSize::Div | SFXSize::Neg | operator% | SFXSize::operator%=


SFXSize::ModHeight
このサイズの高さを指定された値で剰余します。
[ public ]
SFXSizeRef ModHeight(
    SInt16 param   // 剰余する値
);

戻り値

このサイズの高さを指定された値で剰余した後のこのサイズ

解説

この関数は、このサイズの高さを指定された値で剰余します。

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

参照

SFXSize::Mod | SFXSize::ModWidth | SFXSize::AddHeight | SFXSize::SubHeight | SFXSize::MulHeight | SFXSize::DivHeight | SFXSize::NegHeight


SFXSize::ModWidth
このサイズの幅を指定された値で剰余します。
[ public ]
SFXSizeRef ModWidth(
    SInt16 param   // 幅を剰余する値
);

戻り値

このサイズの幅を指定された値で剰余した後のこのサイズ

解説

この関数は、このサイズの幅を指定された値で剰余します。

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

参照

SFXSize::Mod | SFXSize::ModHeight | SFXSize::AddWidth | SFXSize::SubWidth | SFXSize::MulWidth | SFXSize::DivWidth | SFXSize::NegWidth


SFXSize::Mul
このサイズに指定された値を乗算します。
[ public ]
SFXSizeRef Mul(
    SInt16 width    // 幅に乗算する値
    SInt16 height   // 高さに乗算する値
);
[ public ]
SFXSizeRef Mul(
    SInt16 param   // 幅と高さに乗算する値
);

戻り値

このサイズに指定された値を乗算した後のこのサイズ

解説

この関数は、このサイズに指定された値を乗算します。

参照

SFXSize::MulWidth | SFXSize::MulHeight | SFXSize::Add | SFXSize::Sub | SFXSize::Div | SFXSize::Mod | SFXSize::Neg | operator* | SFXSize::operator*=


SFXSize::MulHeight
このサイズの高さに指定された値を乗算します。
[ public ]
SFXSizeRef MulHeight(
    SInt16 param   // 乗算する値
);

戻り値

このサイズの高さに指定された値を乗算した後のこのサイズ

解説

この関数は、このサイズの高さに指定された値を乗算します。

参照

SFXSize::Mul | SFXSize::MulWidth | SFXSize::AddHeight | SFXSize::SubHeight | SFXSize::DivHeight | SFXSize::ModHeight | SFXSize::NegHeight


SFXSize::MulWidth
このサイズの幅に指定された値を乗算します。
[ public ]
SFXSizeRef MulWidth(
    SInt16 param   // 乗算する値
);

戻り値

このサイズの幅に指定された値を乗算した後のこのサイズ

解説

この関数は、このサイズの幅に指定された値を乗算します。

参照

SFXSize::Mul | SFXSize::MulHeight | SFXSize::AddWidth | SFXSize::SubWidth | SFXSize::DivWidth | SFXSize::ModWidth | SFXSize::NegWidth


SFXSize::Neg
このサイズの符号を反転します。
[ public ]
SFXSizeRef Neg(Void);

戻り値

このサイズ(高さと幅)の符号を反転させた後のこのサイズ

解説

この関数は、このサイズ(高さと幅)の符号を反転します。

[Note] 注意

この関数は計算用に用意されています。

参照

SFXSize::NegWidth | SFXSize::NegHeight | SFXSize::Add | SFXSize::Sub | SFXSize::Mul | SFXSize::Div | SFXSize::Mod


SFXSize::NegHeight
このサイズの高さの符号を反転します。
[ public ]
SFXSizeRef NegHeight(Void);

戻り値

このサイズの高さの符号を反転させた後のこのサイズ

解説

この関数は、このサイズの高さの符号を反転します。

[Note] 注意

この関数は計算用に用意されています。

参照

SFXSize::Neg | SFXSize::NegWidth | SFXSize::AddHeight | SFXSize::SubHeight | SFXSize::MulHeight | SFXSize::DivHeight | SFXSize::ModHeight


SFXSize::NegWidth
このサイズの幅の符号を反転します。
[ public ]
SFXSizeRef NegWidth(Void);

戻り値

このサイズの幅の符号を反転させた後のこのサイズ

解説

この関数は、このサイズの幅の符号を反転します。

[Note] 注意

この関数は計算用に用意されています。

参照

SFXSize::Neg | SFXSize::NegHeight | SFXSize::AddWidth | SFXSize::SubWidth | SFXSize::MulWidth | SFXSize::DivWidth | SFXSize::ModWidth


SFXSize::Normalize
このサイズを正規化します。
[ public ]
SFXSizeRef Normalize(Void);

戻り値

正規化した後のこのサイズ

解説

この関数は、このサイズを正規化します。

[Note] サイズの正規化

サイズの正規化とは、 幅または高さが負の値である場合に、 符号を反転させて正の値にする操作のことです。


SFXSize::Set
このサイズを指定された値に設定します。
[ public ]
SFXSizeRef Set(
    SFXSizeConstRef param   // コピー元のサイズ  (SFXSize )
);
[ public ]
SFXSizeRef Set(
    SInt16 width    // 幅
    SInt16 height   // 高さ
);
[ public ]
SFXSizeRef Set(
    SFXGridConstRef grid   // コピー元のサイズ ( SFXGrid )
);

戻り値

設定後のこのサイズ

解説

この関数は、このサイズ(幅と高さ)を指定された値に設定します。

[Note] 注意

指定された値が SFXGrid クラスの場合、 SFXGrid クラスの X 座標と Y 座標をそれぞれ SFXSize クラスの幅と高さと解釈します。

参照

SFXSize::operator=


SFXSize::SetHeight
このサイズの高さを指定された値に設定します。
[ public ]
SFXSizeRef SetHeight(
    SInt16 param   // 設定する値
);

戻り値

設定後のこのサイズ

解説

この関数は、このサイズの高さを指定された値に設定します。

参照

SFXSize::GetHeight | SFXSize::Set | SFXSize::SetWidth |


SFXSize::SetWidth
このサイズの幅を指定された値に設定します。
[ public ]
SFXSizeRef SetWidth(
    SInt16 param   // 設定する値
);

戻り値

設定後のこのサイズ

解説

この関数は、このサイズの幅を指定された値に設定します。

参照

SFXSize::GetWidth | SFXSize::SetHeight | SFXSize::Set


SFXSize::Sub
このサイズから指定された値を減算します。
[ public ]
SFXSizeRef Sub(
    SFXSizeConstRef param   // 幅と高さから減算する値 ( SFXSize )
);
[ public ]
SFXSizeRef Sub(
    SInt16 width    // 幅から減算する値
    SInt16 height   // 高さから減算する値
);
[ public ]
SFXSizeRef Sub(
    SFXGridConstRef grid   // 幅と高さから減算する値 ( SFXGrid )
);

戻り値

このサイズから指定された値を減算した後のこのサイズ

解説

この関数は、このサイズから指定された値を減算します。

[Note] 注意

このサイズは指定された値を減算した分だけ縮小しています。

[Note] 注意

指定された値が SFXGrid クラスの場合、 SFXGrid クラスの X 座標と Y 座標をそれぞれ SFXSize クラスの幅と高さと解釈します。

参照

SFXSize::SubWidth | SFXSize::SubHeight | SFXSize::Add | SFXSize::Mul | SFXSize::Div | SFXSize::Mod | SFXSize::Neg | operator- | SFXSize::operator-=


SFXSize::SubHeight
このサイズの高さから指定された値を減算します。
[ public ]
SFXSizeRef SubHeight(
    SInt16 param   // 減算する値
);

戻り値

このサイズの高さから指定された値を減算した後のこのサイズ

解説

この関数は、このサイズの高さから指定された値を減算します。

[Note] 注意

このサイズは指定された値を減算した分だけ縮小しています。

参照

SFXSize::Sub | SFXSize::SubWidth | SFXSize::AddHeight | SFXSize::MulHeight | SFXSize::DivHeight | SFXSize::ModHeight | SFXSize::NegHeight


SFXSize::SubWidth
このサイズの幅から指定された値を減算します。
[ public ]
SFXSizeRef SubWidth(
    SInt16 param   // 減算する値
);

戻り値

このサイズの幅から指定された値を減算した後のこのサイズ

解説

この関数は、このサイズの幅から指定された値を減算します。

[Note] 注意

このサイズは指定された値を減算した分だけ縮小しています。

参照

SFXSize::Sub | SFXSize::SubHeight | SFXSize::AddWidth | SFXSize::MulWidth | SFXSize::DivWidth | SFXSize::ModWidth | SFXSize::NegWidth


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

戻り値

0 を表す SFXSize インスタンス

解説

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

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

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

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

[Note] 注意

SFXSize::EmptyInstance 関数の戻り値は、この関数の戻り値と同じです。

使用例

SFXSize size(10, 20);

size = SFXSize::ZeroInstance();   // size を初期化する
TRACE("width = %d, height = %d", size.GetWidth(), size.GetHeight());  // width = 0, height = 0

参照

SFXSize::AtomRec | SFXSize::EmptyInstance


atomic_cast
SFXSize クラスを SFXSize::AtomRec 構造体に型変換します。
[ public, friend ]
SFXSize::AtomRec * atomic_cast(
    SFXSize * param   // キャストするサイズ
);
[ public, friend ]
SFXSize::AtomRec const * atomic_cast(
    SFXSize const * param   // キャストするサイズ
);

解説

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

参照

SFXSize::AtomRec


SFXSize::operator=
左側のサイズに右側の値を代入します。
[ public ]
SFXSizeRef operator=(
    SFXSizeConstRef param   // コピー元のサイズ ( SFXSize )
);
[ public ]
SFXSizeRef operator=(
    SFXGridConstRef grid   // コピー元のサイズ ( SFXGrid )
);

戻り値

右側の値を代入した後の左側のサイズ

解説

このオペレーターは、左側のサイズに右側の値を代入します。

[Note] 注意

右側の値が SFXGrid クラスの場合、 SFXGrid クラスの X 座標と Y 座標をそれぞれ SFXSize クラスの幅と高さと解釈します。

参照

SFXSize::Set


SFXSize::operator/=
左側のサイズを右側の値で除算します。
[ public ]
SFXSizeRef operator/=(
    SInt16 param   // 除算する値
);

戻り値

右側の値で除算した後の左側のサイズ

解説

このオペレーターは、左側のサイズを右側の値で除算します。

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

参照

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


operator/
左側のサイズを右側の値で除算したサイズを返します。
[ public, friend ]
SFXSize operator/(
    SFXSizeConstRef left   // 除算するサイズ
    SInt16 right           // 幅と高さを除算する値
);

戻り値

左側のサイズを右側の値で除算したサイズ

解説

このオペレーターは、左側のサイズを右側の値で除算したサイズを返します。

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

参照

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


operator==
左側のサイズが右側の値と等しいか判定します。
[ public, friend ]
Bool operator==(
    SFXSizeConstRef left    // 比較するサイズ
    SFXSizeConstRef right   // 比較するサイズ
);
[ public, friend ]
Bool operator==(
    SFXSizeConstRef left    // 比較するサイズ
    SFXGridConstRef right   // 比較するサイズ
);

戻り値

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

解説

このオペレーターは、左側のサイズが右側の値と等しいか判定します。

[Note] 注意

指定された値が SFXGrid クラスの場合、 SFXGrid クラスの X 座標と Y 座標をそれぞれ SFXSize クラスの幅と高さと解釈します。

参照

SFXSize::Equals | operator!=


SFXSize::operator-=
左側のサイズから右側の値を減算します。
[ public ]
SFXSizeRef operator-=(
    SFXSizeConstRef param   // 減算する幅と高さ ( SFXSize )
);
[ public ]
SFXSizeRef operator-=(
    SFXGridConstRef grid   // 減算する幅と高さ ( SFXGrid )
);

戻り値

右側の値を減算した後の左側のサイズ

解説

このオペレーターは、左側のサイズから右側の値を減算します。

[Note] 注意

左側のサイズは右側の値を減算した分だけ縮小しています。

[Note] 注意

右側の値が SFXGrid クラスの場合、 SFXGrid クラスの X 座標と Y 座標をそれぞれ SFXSize クラスの幅と高さと解釈します。

参照

operator- | SFXSize::operator+=


operator-
左側のサイズから右側の値を減算したサイズを返します。
[ public, const ]
SFXSize operator-(Void);
[ public, friend ]
SFXSize operator-(
    SFXSizeConstRef left    // 減算対象のサイズ
    SFXSizeConstRef right   // 減算する幅と高さ ( SFXSize )
);
[ public, friend ]
SFXSize operator-(
    SFXSizeConstRef left    // 
    SFXGridConstRef right   // 減算する幅と高さ ( SFXGrid )
);

戻り値

左側のサイズから右側の値を減算したサイズ

解説

このオペレーターは、左側のサイズから右側の値を減算したサイズを返します。

このオペレーターが単項演算子の場合は(operator- の引数が Void 型のとき)、 オペランドのサイズ(幅と高さ)の符号を反転させたサイズを返します。

[Note] 注意

戻り値のサイズは、左側のサイズよりも右側の値を減算した分だけ縮小しています。

[Note] 注意

右側の値が SFXGrid クラスの場合、 SFXGrid クラスの X 座標と Y 座標をそれぞれ SFXSize クラスの幅と高さと解釈します。

参照

SFXSize::operator-= | operator+


SFXSize::operator%=
左側のサイズを右側の値で剰余します。
[ public ]
SFXSizeRef operator%=(
    SInt16 param   // 剰余する値
);

戻り値

右側の値で剰余した後の左側のサイズ

解説

このオペレーターは、左側のサイズを右側の値で剰余します。

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

参照

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


operator%
左側のサイズを右側の値で剰余したサイズを返します。
[ public, friend ]
SFXSize operator%(
    SFXSizeConstRef left   // 剰余対象のサイズ
    SInt16 right           // 剰余する値
);

戻り値

左側のサイズを右側の値で剰余したサイズ

解説

このオペレーターは、左側のサイズを右側の値で剰余したサイズを返します。

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

参照

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


SFXSize::operator*=
左側のサイズを右側の値で乗算します。
[ public ]
SFXSizeRef operator*=(
    SInt16 param   // 乗算する値
);

戻り値

右側の値で乗算した後の左側のサイズ

解説

このオペレーターは、左側のサイズを右側の値で乗算します。

参照

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


operator*
左側のサイズを右側の値で乗算したサイズを返します。
[ public, friend ]
SFXSize operator*(
    SFXSizeConstRef left   // 乗算対象のサイズ
    SInt16 right           // 乗算する値
);

戻り値

左側のサイズを右側の値で乗算したサイズ

解説

このオペレーターは、左側のサイズを右側の値で乗算したサイズを返します。

参照

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


operator!=
左側のサイズが右側の値と異なるか判定します。
[ public, friend ]
Bool operator!=(
    SFXSizeConstRef left    // 比較するサイズ
    SFXSizeConstRef right   // 比較するサイズ
);
[ public, friend ]
Bool operator!=(
    SFXSizeConstRef left    // 比較するサイズ
    SFXGridConstRef right   // 比較するサイズ
);

戻り値

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

解説

このオペレーターは、左側のサイズが右側の値と異なるか判定します。

[Note] 注意

右側の値が SFXGrid クラスの場合、 SFXGrid クラスの X 座標と Y 座標をそれぞれ SFXSize クラスの幅と高さと解釈します。

参照

SFXSize::Equals | operator==


SFXSize::operator+=
左側のサイズに右側の値を加算します。
[ public ]
SFXSizeRef operator+=(
    SFXSizeConstRef param   // 加算する値 ( SFXSize )
);
[ public ]
SFXSizeRef operator+=(
    SFXGridConstRef grid   // 加算する値 ( SFXGrid )
);

戻り値

右側の値を加算した後の左側のサイズ

解説

このオペレーターは、左側のサイズに右側の値を加算します。

[Note] 注意

左側のサイズは右側の値を加算した分だけ拡大しています。

[Note] 注意

右側の値が SFXGrid クラスの場合、 SFXGrid クラスの X 座標と Y 座標をそれぞれ SFXSize クラスの幅と高さと解釈します。

参照

operator+ | SFXSize::operator-=


operator+
左側のサイズに右側の値を加算したサイズを返します。
[ public, const ]
SFXSize operator+(Void);
[ public, friend ]
SFXSize operator+(
    SFXSizeConstRef left    // 加算対象のサイズ
    SFXSizeConstRef right   // 加算する幅と高さ ( SFXSize )
);
[ public, friend ]
SFXSize operator+(
    SFXSizeConstRef left    // 加算対象のサイズ
    SFXGridConstRef right   // 加算する幅と高さ ( SFXGrid )
);

戻り値

左側のサイズに右側の値を加算したサイズ

解説

このオペレーターは、左側のサイズに右側の値を加算したサイズを返します。

このオペレーターが単項演算子の場合は(operator+ の引数が Void 型のとき)、オペランドのサイズをそのまま返します。

[Note] 注意

戻り値のサイズは、左側のサイズよりも右側の値を加算した分だけ拡大しています。

[Note] 注意

右側の値が SFXGrid クラスの場合、 SFXGrid クラスの X 座標と Y 座標をそれぞれ SFXSize クラスの幅と高さと解釈します。

参照

SFXSize::operator+= | operator-


SFXSize::AtomRec
サイズを表す構造体です。
struct AtomRec {
  SInt16  width;   // 幅
  SInt16  height;  // 高さ
};

参照

BREW API AEESize