IWICDdsEncoder

COM

IID5cacdb4c-407e-41b3-b936-d0f010cd6732継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

DDS フォーマット固有の情報をエンコーダーへ書き込めるようにします。

解説(Remarks)

このインターフェイスは WIC DDS コーデックによって実装されます。このインターフェイスを取得するには、DDS コーデックを使用して IWICBitmapEncoder を作成し、IWICDdsEncoder に対して QueryInterface を呼び出します。

メソッド 3

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT SetParameters(WICDdsParameters* pParameters)

DDS 固有のデータを設定します。

pParameters

WICDdsParameters*

情報を記述する構造体を指します。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

フレームデータの書き込みを開始した後(たとえば IWICDdsEncoder::CreateNewFrame を呼び出した後)は、このメソッドを呼び出すことはできません。

このメソッドで DDS パラメーターを設定すると、DDS エンコーダーに対して、想定されるフレーム数や各フレームの寸法などのパラメーターに関する情報が提供されます。これらの想定に一致しないフレームデータを設定した場合、DDS エンコーダーは失敗します。たとえば、WICDdsParameters::Width と Height を 32 に、MipLevels を 6 に設定した場合、DDS エンコーダーは次の寸法を持つ 6 個のフレームを想定します。

32x32 ピクセル。
16x16 ピクセル。
8x8 ピクセル。
4x4 ピクセル。
2x2 ピクセル。
1x1 ピクセル。

vtbl 4 HRESULT GetParameters(WICDdsParameters* pParameters)

DDS 固有のデータを取得します。(IWICDdsEncoder.GetParameters)

pParameters

WICDdsParameters*

out

情報が返される構造体を指します。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

アプリケーションは GetParameters を呼び出してデフォルトの DDS パラメーターを取得し、その一部またはすべてを変更してから SetParameters を呼び出すことができます。

vtbl 5 HRESULT CreateNewFrame(IWICBitmapFrameEncode** ppIFrameEncode, DWORD* pArrayIndex, DWORD* pMipLevel, DWORD* pSliceIndex)

エンコードする新しいフレームを作成します。

ppIFrameEncode	IWICBitmapFrameEncode**	out	新しく作成されたフレームオブジェクトへのポインター。
pArrayIndex	DWORD*	out	配列インデックスが返される場所を指します。
pMipLevel	DWORD*	out	ミップレベルインデックスが返される場所を指します。
pSliceIndex	DWORD*	out	スライスインデックスが返される場所を指します。

戻り値

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

これは IWICBitmapEncoder::CreateNewFrame と同等ですが、新しく作成されたフレームの配列インデックス、ミップレベル、スライスに関する追加情報を返します。IWICBitmapEncoder::CreateNewFrame とは異なり、個々の DDS フレームは個別のプロパティを持たないため、IPropertyBag2* パラメーターはありません。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数:

#define global IID_IWICDdsEncoder "{5CACDB4C-407E-41B3-B936-D0F010CD6732}"
#usecom global IWICDdsEncoder IID_IWICDdsEncoder "{A61DDE94-66CE-4AC1-881B-71680588895E}"
#comfunc global IWICDdsEncoder_SetParameters   3 var
#comfunc global IWICDdsEncoder_GetParameters   4 var
#comfunc global IWICDdsEncoder_CreateNewFrame  5 sptr,var,var,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IWICDdsEncoder "{5CACDB4C-407E-41B3-B936-D0F010CD6732}"
#usecom global IWICDdsEncoder IID_IWICDdsEncoder "{A61DDE94-66CE-4AC1-881B-71680588895E}"
#comfunc global IWICDdsEncoder_SetParameters   3 sptr
#comfunc global IWICDdsEncoder_GetParameters   4 sptr
#comfunc global IWICDdsEncoder_CreateNewFrame  5 sptr,sptr,sptr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。