Effekseer
公開メンバ関数 | 静的公開メンバ関数 | 全メンバ一覧
Effekseer::Effect クラスabstract

エフェクトパラメータークラス [詳解]

#include <Effekseer.h>

Effekseer::Effect の継承関係図
Effekseer::IReference

公開メンバ関数

virtual SettingGetSetting () const =0
 設定を取得する。 [詳解]
 
virtual float GetMaginification () const =0
 読み込み時と出力時の拡大率をかけた拡大率を取得する。
 
virtual int GetVersion () const =0
 エフェクトデータのバージョン取得
 
virtual TextureDataGetColorImage (int n) const =0
 格納されている色画像のポインタを取得する。 [詳解]
 
virtual int32_t GetColorImageCount () const =0
 格納されている画像のポインタの個数を取得する。
 
virtual TextureDataGetNormalImage (int n) const =0
 格納されている法線画像のポインタを取得する。 [詳解]
 
virtual int32_t GetNormalImageCount () const =0
 格納されている法線画像のポインタの個数を取得する。
 
virtual TextureDataGetDistortionImage (int n) const =0
 格納されている歪み画像のポインタを取得する。 [詳解]
 
virtual int32_t GetDistortionImageCount () const =0
 格納されている歪み画像のポインタの個数を取得する。
 
virtual void * GetWave (int n) const =0
 格納されている音波形のポインタを取得する。
 
virtual int32_t GetWaveCount () const =0
 格納されている音波形のポインタの個数を取得する。
 
virtual void * GetModel (int n) const =0
 格納されているモデルのポインタを取得する。
 
virtual int32_t GetModelCount () const =0
 格納されているモデルのポインタの個数を取得する。
 
virtual bool Reload (void *data, int32_t size, const EFK_CHAR *materialPath=NULL)=0
 エフェクトのリロードを行う。
 
virtual bool Reload (const EFK_CHAR *path, const EFK_CHAR *materialPath=NULL)=0
 エフェクトのリロードを行う。
 
virtual bool Reload (Manager *managers, int32_t managersCount, void *data, int32_t size, const EFK_CHAR *materialPath=NULL)=0
 エフェクトのリロードを行う。 [詳解]
 
virtual bool Reload (Manager *managers, int32_t managersCount, const EFK_CHAR *path, const EFK_CHAR *materialPath=NULL)=0
 エフェクトのリロードを行う。 [詳解]
 
virtual void ReloadResources (const EFK_CHAR *materialPath=NULL)=0
 画像等リソースの再読み込みを行う。
 
virtual void UnloadResources ()=0
 画像等リソースの破棄を行う。
 
virtual EffectNodeGetRoot () const =0
 Rootを取得する。
 
- 基底クラス Effekseer::IReference に属する継承公開メンバ関数
virtual int AddRef ()=0
 参照カウンタを加算する。 [詳解]
 
virtual int GetRef ()=0
 参照カウンタを取得する。 [詳解]
 
virtual int Release ()=0
 参照カウンタを減算する。0になった時、インスタンスを削除する。 [詳解]
 

静的公開メンバ関数

static EffectCreate (Manager *manager, void *data, int32_t size, float magnification=1.0f, const EFK_CHAR *materialPath=NULL)
 エフェクトを生成する。 [詳解]
 
static EffectCreate (Manager *manager, const EFK_CHAR *path, float magnification=1.0f, const EFK_CHAR *materialPath=NULL)
 エフェクトを生成する。 [詳解]
 
static EffectCreate (Setting *setting, void *data, int32_t size, float magnification=1.0f, const EFK_CHAR *materialPath=NULL)
 エフェクトを生成する。 [詳解]
 
static EffectCreate (Setting *setting, const EFK_CHAR *path, float magnification=1.0f, const EFK_CHAR *materialPath=NULL)
 エフェクトを生成する。 [詳解]
 
::Effekseer::EffectLoaderCreateEffectLoader (::Effekseer::FileInterface *fileInterface=NULL)
 標準のエフェクト読込インスタンスを生成する。
 

詳解

エフェクトパラメータークラス

覚え書き
エフェクトに設定されたパラメーター。

関数詳解

◆ Create() [1/4]

static Effect* Effekseer::Effect::Create ( Manager manager,
void *  data,
int32_t  size,
float  magnification = 1.0f,
const EFK_CHAR *  materialPath = NULL 
)
static

エフェクトを生成する。

引数
manager[in] 管理クラス
data[in] データ配列の先頭のポインタ
size[in] データ配列の長さ
magnification[in] 読み込み時の拡大率
materialPath[in] 素材ロード時の基準パス
戻り値
エフェクト。失敗した場合はNULLを返す。

◆ Create() [2/4]

static Effect* Effekseer::Effect::Create ( Manager manager,
const EFK_CHAR *  path,
float  magnification = 1.0f,
const EFK_CHAR *  materialPath = NULL 
)
static

エフェクトを生成する。

引数
manager[in] 管理クラス
path[in] 読込元のパス
magnification[in] 読み込み時の拡大率
materialPath[in] 素材ロード時の基準パス
戻り値
エフェクト。失敗した場合はNULLを返す。

◆ Create() [3/4]

static Effect* Effekseer::Effect::Create ( Setting setting,
void *  data,
int32_t  size,
float  magnification = 1.0f,
const EFK_CHAR *  materialPath = NULL 
)
static

エフェクトを生成する。

引数
setting[in] 設定クラス
data[in] データ配列の先頭のポインタ
size[in] データ配列の長さ
magnification[in] 読み込み時の拡大率
materialPath[in] 素材ロード時の基準パス
戻り値
エフェクト。失敗した場合はNULLを返す。

◆ Create() [4/4]

static Effect* Effekseer::Effect::Create ( Setting setting,
const EFK_CHAR *  path,
float  magnification = 1.0f,
const EFK_CHAR *  materialPath = NULL 
)
static

エフェクトを生成する。

引数
setting[in] 設定クラス
path[in] 読込元のパス
magnification[in] 読み込み時の拡大率
materialPath[in] 素材ロード時の基準パス
戻り値
エフェクト。失敗した場合はNULLを返す。

◆ GetColorImage()

virtual TextureData* Effekseer::Effect::GetColorImage ( int  n) const
pure virtual

格納されている色画像のポインタを取得する。

引数
n[in] 画像のインデックス
戻り値
画像のポインタ

◆ GetDistortionImage()

virtual TextureData* Effekseer::Effect::GetDistortionImage ( int  n) const
pure virtual

格納されている歪み画像のポインタを取得する。

引数
n[in] 画像のインデックス
戻り値
画像のポインタ

◆ GetNormalImage()

virtual TextureData* Effekseer::Effect::GetNormalImage ( int  n) const
pure virtual

格納されている法線画像のポインタを取得する。

引数
n[in] 画像のインデックス
戻り値
画像のポインタ

◆ GetSetting()

virtual Setting* Effekseer::Effect::GetSetting ( ) const
pure virtual

設定を取得する。

戻り値
設定

◆ Reload() [1/2]

virtual bool Effekseer::Effect::Reload ( Manager managers,
int32_t  managersCount,
void *  data,
int32_t  size,
const EFK_CHAR *  materialPath = NULL 
)
pure virtual

エフェクトのリロードを行う。

引数
managers[in] マネージャーの配列
managersCount[in] マネージャーの個数
data[in] エフェクトのデータ
size[in] エフェクトのデータサイズ
materialPath[in] リソースの読み込み元
戻り値
成否
覚え書き
Settingを用いてエフェクトを生成したときに、Managerを指定することで対象のManager内のエフェクトのリロードを行う。

◆ Reload() [2/2]

virtual bool Effekseer::Effect::Reload ( Manager managers,
int32_t  managersCount,
const EFK_CHAR *  path,
const EFK_CHAR *  materialPath = NULL 
)
pure virtual

エフェクトのリロードを行う。

引数
managers[in] マネージャーの配列
managersCount[in] マネージャーの個数
path[in] エフェクトの読み込み元
materialPath[in] リソースの読み込み元
戻り値
成否
覚え書き
Settingを用いてエフェクトを生成したときに、Managerを指定することで対象のManager内のエフェクトのリロードを行う。

このクラス詳解は次のファイルから抽出されました: