Win32 API 日本語リファレンス
ホームGraphics.DirectDraw › IDirectDrawPalette

IDirectDrawPalette

COM
IID6c14db84-a733-11ce-a521-0020af0be560継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

アプリケーションは、IDirectDrawPalette インターフェースのメソッドを使用して DirectDrawPalette オブジェクトを作成し、システムレベルの変数を扱います。このセクションは、このインターフェースのメソッドのリファレンスです。

解説(Remarks)

IDirectDrawPalette インターフェースのメソッドは、次のグループに分類できます:

グループ メソッド
メモリの割り当て Initialize
パレットの機能 GetCaps
パレットエントリ GetEntries および SetEntries

LPDIRECTDRAWPALETTE データ型を使用して、IDirectDrawPalette インターフェースへのポインターを格納する変数を宣言できます。Ddraw.h ヘッダーファイルは、次のコードでこのデータ型を宣言しています:


typedef struct IDirectDrawPalette    FAR *LPDIRECTDRAWPALETTE;

メソッド 4

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

vtbl 3 HRESULT GetCaps(DWORD* param0)

パレットオブジェクトの機能を取得します。

param0DWORD*inoutパレットの能力を示すDDPCAPS_系フラグを受け取る出力ポインタである。

戻り値

メソッドが成功した場合、戻り値は DD_OK です。

失敗した場合、メソッドは次のいずれかのエラー値を返すことがあります:

vtbl 4 HRESULT GetEntries(DWORD param0, DWORD param1, DWORD param2, PALETTEENTRY* param3)

DirectDrawPalette オブジェクトからパレット値を取得します。

param0DWORDin取得動作のフラグ。現状は予約で0を指定する。
param1DWORDin取得を開始するエントリのインデックス(0始まり)である。
param2DWORDin取得するエントリの個数を指定する。
param3PALETTEENTRY*inout取得した色エントリを格納するPALETTEENTRY配列へのポインタである。

戻り値

メソッドが成功した場合、戻り値は DD_OK です。

失敗した場合、メソッドは次のいずれかのエラー値を返すことがあります:

vtbl 5 HRESULT Initialize(IDirectDraw* param0, DWORD param1, PALETTEENTRY* param2)

DirectDrawPalette オブジェクトを初期化します。

param0IDirectDraw*inこのパレットを関連付けるIDirectDrawオブジェクトへのポインタである。
param1DWORDinパレットの能力やビット数を示すDDPCAPS_系フラグである。
param2PALETTEENTRY*inout初期化に用いる色エントリ配列(PALETTEENTRY)へのポインタである。

戻り値

このメソッドは DDERR_ALREADYINITIALIZED を返します。

このメソッドは、Component Object Model (COM) への準拠のために提供されています。DirectDrawPalette オブジェクトは作成時に初期化されるため、このメソッドは常に DDERR_ALREADYINITIALIZED を返します。

vtbl 6 HRESULT SetEntries(DWORD param0, DWORD param1, DWORD param2, PALETTEENTRY* param3)

DirectDrawPalette オブジェクトのエントリをただちに変更します。

param0DWORDin設定動作のフラグ。現状は予約で0を指定する。
param1DWORDin設定を開始するエントリのインデックス(0始まり)である。
param2DWORDin設定するエントリの個数を指定する。
param3PALETTEENTRY*inout設定する色エントリを格納したPALETTEENTRY配列へのポインタである。

戻り値

メソッドが成功した場合、戻り値は DD_OK です。

失敗した場合、メソッドは次のいずれかのエラー値を返すことがあります:

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