Effekseer

- メインページ
- クラス
- ファイル

- 構成
- 構成索引
- クラス階層
- 構成メンバ

全て クラス 関数 変数
Public メソッド | Static Public メソッド | すべてのメンバ一覧
クラス Effekseer::Effectabstract

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

`#include <Effekseer.h>`

Effekseer::Effectに対する継承グラフ

## Public メソッド
virtual Setting * | GetSetting () const =0
| 設定を取得する。 [詳細]
virtual float | GetMaginification () const =0
virtual int | GetVersion () const =0
| エフェクトデータのバージョン取得
virtual TextureData * | GetColorImage (int n) const =0
| 格納されている色画像のポインタを取得する。 [詳細]
virtual int32_t | GetColorImageCount () const =0
| 格納されている画像のポインタの個数を取得する。
virtual TextureData * | GetNormalImage (int n) const =0
| 格納されている法線画像のポインタを取得する。 [詳細]
virtual int32_t | GetNormalImageCount () const =0
| 格納されている法線画像のポインタの個数を取得する。
virtual TextureData * | GetDistortionImage (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 EffectNode * | GetRoot () const =0
| Rootを取得する。
Public メソッド inherited from Effekseer::IReference
virtual int | AddRef ()=0
| 参照カウンタを加算する。 [詳細]
virtual int | GetRef ()=0
| 参照カウンタを取得する。 [詳細]
virtual int | Release ()=0
| 参照カウンタを減算する。0になった時、インスタンスを削除する。 [詳細]

## Static Public メソッド
static Effect * | Create (Manager *manager, void *data, int32_t size, float magnification=1.0f, const EFK_CHAR *materialPath=NULL)
| エフェクトを生成する。 [詳細]
static Effect * | Create (Manager *manager, const EFK_CHAR *path, float magnification=1.0f, const EFK_CHAR *materialPath=NULL)
| エフェクトを生成する。 [詳細]
static Effect * | Create (Setting *setting, void *data, int32_t size, float magnification=1.0f, const EFK_CHAR *materialPath=NULL)
| エフェクトを生成する。 [詳細]
static Effect * | Create (Setting *setting, const EFK_CHAR *path, float magnification=1.0f, const EFK_CHAR *materialPath=NULL)
| エフェクトを生成する。 [詳細]
::Effekseer::EffectLoader * | CreateEffectLoader (::Effekseer::FileInterface *fileInterface=NULL)
| 標準のエフェクト読込インスタンスを生成する。

## 説明

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

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

## 関数

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を返す。

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を返す。

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を返す。

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を返す。

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

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

引数

  n | [in] 画像のインデックス

戻り値
  画像のポインタ

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

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

引数

  n | [in] 画像のインデックス

戻り値
  画像のポインタ

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

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

引数

  n | [in] 画像のインデックス

戻り値
  画像のポインタ

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

設定を取得する。

戻り値
  設定

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内のエフェクトのリロードを行う。

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内のエフェクトのリロードを行う。

このクラスの説明は次のファイルから生成されました:

- Dev/Cpp/Effekseer/Effekseer.h