ホーム › Devices.Display › XLATEOBJ_cGetPalette

XLATEOBJ_cGetPalette

関数

色変換オブジェクトからパレット情報を取得する。

DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// GDI32.dll
#include <windows.h>

DWORD XLATEOBJ_cGetPalette(
    XLATEOBJ* pxlo,
    DWORD iPal,
    DWORD cPal,
    DWORD* pPal
);

パラメーター

名前

型

方向

説明

pxlo

XLATEOBJ*

inout

GDI が要求された情報を取得する元となる XLATEOBJ 構造体へのポインターです。

iPal

DWORD

書き込むパレット情報を指定します。このパラメーターには次のいずれかの値を指定できます。

値	意味
XO_DESTBITFIELDS	GDI は、宛先パレットのビットフィールド形式を取得します。
XO_DESTPALETTE	GDI は、宛先パレットから RGB カラーを取得します。
XO_SRCBITFIELDS	GDI は、ソースパレットのビットフィールド形式を取得します。
XO_SRCPALETTE	GDI は、ソースパレットから RGB カラーを取得します。

cPal

DWORD

pPal が指す先のバッファー内のエントリ数を指定します。これはパレット全体のサイズより小さくてもかまいません。

pPal

DWORD*

inout

GDI が要求されたパレット情報を書き込むバッファーへのポインターです。iPal が XO_SRCPALETTE または XO_DESTPALETTE であり、対応するパレットの種類が PAL_INDEXED の場合、各エントリは 24 ビットの RGB 値になります。

iPal が XO_SRCBITFIELDS または XO_DESTBITFIELDS であり、対応するパレットの種類が PAL_BITFIELDS、PAL_RGB、または PAL_BGR の場合、pPal は赤、緑、青の各カラーマスクを表す 3 つの ULONG マスクを指します。

戻り値の型: DWORD

公式ドキュメント

XLATEOBJ_cGetPalette 関数は、指定したパレットから RGB カラーまたはビットフィールド形式を取得します。

戻り値

XLATEOBJ_cGetPalette は、pPal が null でない場合、書き込まれたエントリ数を返します。XLATEOBJ が null であるか、そのパレットが無効である場合は 0 が返されます。また、pxlo が指すデータが iPal の値と一致しない場合も、XLATEOBJ_cGetPalette は 0 を返します。たとえば、指す先のデータがビットフィールドであるにもかかわらず、iPal が XO_SRCPALETTE または XO_DESTPALETTE に設定されている場合、XLATEOBJ_cGetPalette は 0 を返します。同様に、pxlo が指すデータがパレットであるにもかかわらず、iPal が XO_SRCBITFIELDS または XO_DESTBITFIELDS に設定されている場合も、XLATEOBJ_cGetPalette は 0 を返します。

解説(Remarks)

ドライバーは、一部の色のブレンド手法を実行するために、パレットに関する情報を持っている必要があります。

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

各言語での呼び出し定義

// GDI32.dll
#include <windows.h>

DWORD XLATEOBJ_cGetPalette(
    XLATEOBJ* pxlo,
    DWORD iPal,
    DWORD cPal,
    DWORD* pPal
);

[DllImport("GDI32.dll", ExactSpelling = true)]
static extern uint XLATEOBJ_cGetPalette(
    IntPtr pxlo,   // XLATEOBJ* in/out
    uint iPal,   // DWORD
    uint cPal,   // DWORD
    ref uint pPal   // DWORD* in/out
);

<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function XLATEOBJ_cGetPalette(
    pxlo As IntPtr,   ' XLATEOBJ* in/out
    iPal As UInteger,   ' DWORD
    cPal As UInteger,   ' DWORD
    ByRef pPal As UInteger   ' DWORD* in/out
) As UInteger
End Function

' pxlo : XLATEOBJ* in/out
' iPal : DWORD
' cPal : DWORD
' pPal : DWORD* in/out
Declare PtrSafe Function XLATEOBJ_cGetPalette Lib "gdi32" ( _
    ByVal pxlo As LongPtr, _
    ByVal iPal As Long, _
    ByVal cPal As Long, _
    ByRef pPal As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

XLATEOBJ_cGetPalette = ctypes.windll.gdi32.XLATEOBJ_cGetPalette
XLATEOBJ_cGetPalette.restype = wintypes.DWORD
XLATEOBJ_cGetPalette.argtypes = [
    ctypes.c_void_p,  # pxlo : XLATEOBJ* in/out
    wintypes.DWORD,  # iPal : DWORD
    wintypes.DWORD,  # cPal : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pPal : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
XLATEOBJ_cGetPalette = Fiddle::Function.new(
  lib['XLATEOBJ_cGetPalette'],
  [
    Fiddle::TYPE_VOIDP,  # pxlo : XLATEOBJ* in/out
    -Fiddle::TYPE_INT,  # iPal : DWORD
    -Fiddle::TYPE_INT,  # cPal : DWORD
    Fiddle::TYPE_VOIDP,  # pPal : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn XLATEOBJ_cGetPalette(
        pxlo: *mut XLATEOBJ,  // XLATEOBJ* in/out
        iPal: u32,  // DWORD
        cPal: u32,  // DWORD
        pPal: *mut u32  // DWORD* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("GDI32.dll")]
public static extern uint XLATEOBJ_cGetPalette(IntPtr pxlo, uint iPal, uint cPal, ref uint pPal);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_XLATEOBJ_cGetPalette' -Namespace Win32 -PassThru
# $api::XLATEOBJ_cGetPalette(pxlo, iPal, cPal, pPal)

#uselib "GDI32.dll"
#func global XLATEOBJ_cGetPalette "XLATEOBJ_cGetPalette" sptr, sptr, sptr, sptr
; XLATEOBJ_cGetPalette varptr(pxlo), iPal, cPal, varptr(pPal)   ; 戻り値は stat
; pxlo : XLATEOBJ* in/out -> "sptr"
; iPal : DWORD -> "sptr"
; cPal : DWORD -> "sptr"
; pPal : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "GDI32.dll"
#cfunc global XLATEOBJ_cGetPalette "XLATEOBJ_cGetPalette" var, int, int, var
; res = XLATEOBJ_cGetPalette(pxlo, iPal, cPal, pPal)
; pxlo : XLATEOBJ* in/out -> "var"
; iPal : DWORD -> "int"
; cPal : DWORD -> "int"
; pPal : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "GDI32.dll"
#cfunc global XLATEOBJ_cGetPalette "XLATEOBJ_cGetPalette" sptr, int, int, sptr
; res = XLATEOBJ_cGetPalette(varptr(pxlo), iPal, cPal, varptr(pPal))
; pxlo : XLATEOBJ* in/out -> "sptr"
; iPal : DWORD -> "int"
; cPal : DWORD -> "int"
; pPal : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。