Win32 API 日本語リファレンス
ホームGraphics.Imaging.D2D › IWICImageEncoder

IWICImageEncoder

COM
IID04c75bf8-3ce1-473b-acc5-3cc4f5e94999継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ID2D1Image インターフェイスを IWICBitmapEncoder へエンコードします。

メソッド 3

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

vtbl 3 HRESULT WriteFrame(ID2D1Image* pImage, IWICBitmapFrameEncode* pFrameEncode, WICImageParameters* pImageParameters)

IWICBitmapFrameEncode で指定されたフレームに画像をエンコードします。

pImageID2D1Image*inエンコードされる Direct2D 画像です。
pFrameEncodeIWICBitmapFrameEncode*in画像の書き込み先となるフレームエンコーダーです。
pImageParametersWICImageParameters*inエンコードを制御する追加のパラメーターです。

戻り値

型: HRESULT

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

解説(Remarks)

渡す画像は、IWICImagingFactory2::CreateImageEncoder で指定したものと同じデバイス上で作成されている必要があります。pImageParameters を指定しない場合は、有用な既定値のセットが使用されます。詳細については WICImageParameters を参照してください。

この API を呼び出す前に、IWICBitmapFrameEncode を正しく個別に設定しておく必要があります。

vtbl 4 HRESULT WriteFrameThumbnail(ID2D1Image* pImage, IWICBitmapFrameEncode* pFrameEncode, WICImageParameters* pImageParameters)

IWICBitmapFrameEncode で指定されたフレームに、画像をサムネイルとしてエンコードします。

pImageID2D1Image*inエンコードされる Direct2D 画像です。
pFrameEncodeIWICBitmapFrameEncode*inサムネイルを設定する対象のフレームエンコーダーです。
pImageParametersWICImageParameters*inエンコードを制御する追加のパラメーターです。

戻り値

型: HRESULT

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

解説(Remarks)

渡す画像は、IWICImagingFactory2::CreateImageEncoder で指定したものと同じデバイス上で作成されている必要があります。pImageParameters を指定しない場合は、有用な既定値のセットが使用されます。詳細については WICImageParameters を参照してください。

この API を呼び出す前に、IWICBitmapFrameEncode を正しく個別に設定しておく必要があります。

vtbl 5 HRESULT WriteThumbnail(ID2D1Image* pImage, IWICBitmapEncoder* pEncoder, WICImageParameters* pImageParameters)

指定した画像を、指定した WIC ビットマップエンコーダーのサムネイルとしてエンコードします。

pImageID2D1Image*inエンコードされる Direct2D 画像です。
pEncoderIWICBitmapEncoder*inサムネイルを設定する対象のエンコーダーです。
pImageParametersWICImageParameters*inエンコードを制御する追加のパラメーターです。

戻り値

型: HRESULT

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

解説(Remarks)

渡す画像は、IWICImagingFactory2::CreateImageEncoder で指定したものと同じデバイス上で作成する必要があります。pImageParameters が指す変数に追加のパラメーターを指定しない場合、エンコーダーは有用な既定値のセットを使用します。これらの既定値については、WICImageParameters を参照してください。

WriteThumbnail を呼び出す前に、サムネイルを設定する対象のエンコーダーの IWICBitmapEncoder インターフェイスを設定しておく必要があります。

WriteThumbnail が失敗した場合、E_OUTOFMEMORYD2DERR_WRONG_RESOURCE_DOMAIN、またはエンコーダーからのその他のエラーコードが返されることがあります。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IWICImageEncoder "{04C75BF8-3CE1-473B-ACC5-3CC4F5E94999}"
#usecom global IWICImageEncoder IID_IWICImageEncoder "{}"
#comfunc global IWICImageEncoder_WriteFrame           3 sptr,sptr,var
#comfunc global IWICImageEncoder_WriteFrameThumbnail  4 sptr,sptr,var
#comfunc global IWICImageEncoder_WriteThumbnail       5 sptr,sptr,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。