AnimatePalette

関数

論理パレットのエントリを置き換えてパレットアニメーションを行う。

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

シグネチャ

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

BOOL AnimatePalette(
    HPALETTE hPal,
    DWORD iStartIndex,
    DWORD cEntries,
    const PALETTEENTRY* ppe
);

パラメーター

名前	型	方向	説明
hPal	HPALETTE	in	論理パレットへのハンドル。
iStartIndex	DWORD	in	置き換える最初の論理パレットエントリ。
cEntries	DWORD	in	置き換えるエントリの数。
ppe	PALETTEENTRY*	in	現在のエントリを置き換えるために使用される PALETTEENTRY 構造体の配列の最初のメンバーへのポインター。

戻り値の型: BOOL

公式ドキュメント

AnimatePalette 関数は、指定した論理パレット内のエントリを置き換えます。

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。

解説(Remarks)

アプリケーションは、GetDeviceCaps 関数を呼び出して RASTERCAPS 定数を指定することで、デバイスがパレット操作をサポートしているかどうかを判別できます。

AnimatePalette 関数は、LOGPALETTE 構造体の対応する palPalEntry メンバーに PC_RESERVED フラグが設定されているエントリのみを変更します。

指定したパレットがアクティブウィンドウに関連付けられている場合、パレット内の色はただちに置き換えられます。

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

各言語での呼び出し定義

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

BOOL AnimatePalette(
    HPALETTE hPal,
    DWORD iStartIndex,
    DWORD cEntries,
    const PALETTEENTRY* ppe
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern bool AnimatePalette(
    IntPtr hPal,   // HPALETTE
    uint iStartIndex,   // DWORD
    uint cEntries,   // DWORD
    IntPtr ppe   // PALETTEENTRY*
);

<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function AnimatePalette(
    hPal As IntPtr,   ' HPALETTE
    iStartIndex As UInteger,   ' DWORD
    cEntries As UInteger,   ' DWORD
    ppe As IntPtr   ' PALETTEENTRY*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hPal : HPALETTE
' iStartIndex : DWORD
' cEntries : DWORD
' ppe : PALETTEENTRY*
Declare PtrSafe Function AnimatePalette Lib "gdi32" ( _
    ByVal hPal As LongPtr, _
    ByVal iStartIndex As Long, _
    ByVal cEntries As Long, _
    ByVal ppe As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

AnimatePalette = ctypes.windll.gdi32.AnimatePalette
AnimatePalette.restype = wintypes.BOOL
AnimatePalette.argtypes = [
    wintypes.HANDLE,  # hPal : HPALETTE
    wintypes.DWORD,  # iStartIndex : DWORD
    wintypes.DWORD,  # cEntries : DWORD
    ctypes.c_void_p,  # ppe : PALETTEENTRY*
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
AnimatePalette = Fiddle::Function.new(
  lib['AnimatePalette'],
  [
    Fiddle::TYPE_VOIDP,  # hPal : HPALETTE
    -Fiddle::TYPE_INT,  # iStartIndex : DWORD
    -Fiddle::TYPE_INT,  # cEntries : DWORD
    Fiddle::TYPE_VOIDP,  # ppe : PALETTEENTRY*
  ],
  Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn AnimatePalette(
        hPal: *mut core::ffi::c_void,  // HPALETTE
        iStartIndex: u32,  // DWORD
        cEntries: u32,  // DWORD
        ppe: *const PALETTEENTRY  // PALETTEENTRY*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll")]
public static extern bool AnimatePalette(IntPtr hPal, uint iStartIndex, uint cEntries, IntPtr ppe);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_AnimatePalette' -Namespace Win32 -PassThru
# $api::AnimatePalette(hPal, iStartIndex, cEntries, ppe)

#uselib "GDI32.dll"
#func global AnimatePalette "AnimatePalette" sptr, sptr, sptr, sptr
; AnimatePalette hPal, iStartIndex, cEntries, varptr(ppe)   ; 戻り値は stat
; hPal : HPALETTE -> "sptr"
; iStartIndex : DWORD -> "sptr"
; cEntries : DWORD -> "sptr"
; ppe : PALETTEENTRY* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "GDI32.dll"
#cfunc global AnimatePalette "AnimatePalette" sptr, int, int, var
; res = AnimatePalette(hPal, iStartIndex, cEntries, ppe)
; hPal : HPALETTE -> "sptr"
; iStartIndex : DWORD -> "int"
; cEntries : DWORD -> "int"
; ppe : PALETTEENTRY* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "GDI32.dll"
#cfunc global AnimatePalette "AnimatePalette" sptr, int, int, sptr
; res = AnimatePalette(hPal, iStartIndex, cEntries, varptr(ppe))
; hPal : HPALETTE -> "sptr"
; iStartIndex : DWORD -> "int"
; cEntries : DWORD -> "int"
; ppe : PALETTEENTRY* -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。