Win32 API 日本語リファレンス
ホームDevices.Display › HT_Get8BPPFormatPalette

HT_Get8BPPFormatPalette

関数
8bppハーフトーン用フォーマットパレットを取得する。
DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

INT HT_Get8BPPFormatPalette(
    PALETTEENTRY* pPaletteEntry,   // optional
    WORD RedGamma,
    WORD GreenGamma,
    WORD BlueGamma
);

パラメーター

名前方向説明
pPaletteEntryPALETTEENTRY*outoptionalPALETTEENTRY 構造体(Microsoft Windows SDK のドキュメントで説明されています)の配列へのポインターです。このポインターが NULL でない場合、GDI はそれが有効なメモリ領域を指していると見なし、その領域に 8 ビット/ピクセルのハーフトーンパレット全体を格納します。
RedGammaWORDin赤、緑、青のガンマ値を指定します。この USHORT 値は、下位 4 桁が(暗黙の)小数点以下に位置する実数として解釈されます。たとえば、ガンマ値 10000 は実数 1.0000 を表し、12345 は 1.2345 を表します。指定できるガンマ値の最小値は 0.0000、最大値は 6.5535 です。
GreenGammaWORDin赤、緑、青のガンマ値を指定します。この USHORT 値は、下位 4 桁が(暗黙の)小数点以下に位置する実数として解釈されます。たとえば、ガンマ値 10000 は実数 1.0000 を表し、12345 は 1.2345 を表します。指定できるガンマ値の最小値は 0.0000、最大値は 6.5535 です。
BlueGammaWORDin赤、緑、青のガンマ値を指定します。この USHORT 値は、下位 4 桁が(暗黙の)小数点以下に位置する実数として解釈されます。たとえば、ガンマ値 10000 は実数 1.0000 を表し、12345 は 1.2345 を表します。指定できるガンマ値の最小値は 0.0000、最大値は 6.5535 です。

戻り値の型: INT

公式ドキュメント

HT_Get8BPPFormatPalette 関数は、標準的な 8 ビット/ピクセルのデバイスタイプで使用するためのハーフトーンパレットを返します。

戻り値

pPaletteEntryNULL でない場合、戻り値は GDI が pPaletteEntry が指すメモリ位置を起点として埋めた PALETTEENTRY 構造体の数です。pPaletteEntryNULL の場合、戻り値は 8 ビット/ピクセルのハーフトーンパレットを格納するために必要な PALETTEENTRY 構造体の総数です。

解説(Remarks)

HT_Get8BPPFormatPalette は、ドライバーがシステム標準の 8 ビット/ピクセルのハーフトーンパレットを取得するために使用できる、ハーフトーン関連の GDI サービスです。

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

各言語での呼び出し定義

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

INT HT_Get8BPPFormatPalette(
    PALETTEENTRY* pPaletteEntry,   // optional
    WORD RedGamma,
    WORD GreenGamma,
    WORD BlueGamma
);
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern int HT_Get8BPPFormatPalette(
    IntPtr pPaletteEntry,   // PALETTEENTRY* optional, out
    ushort RedGamma,   // WORD
    ushort GreenGamma,   // WORD
    ushort BlueGamma   // WORD
);
<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function HT_Get8BPPFormatPalette(
    pPaletteEntry As IntPtr,   ' PALETTEENTRY* optional, out
    RedGamma As UShort,   ' WORD
    GreenGamma As UShort,   ' WORD
    BlueGamma As UShort   ' WORD
) As Integer
End Function
' pPaletteEntry : PALETTEENTRY* optional, out
' RedGamma : WORD
' GreenGamma : WORD
' BlueGamma : WORD
Declare PtrSafe Function HT_Get8BPPFormatPalette Lib "gdi32" ( _
    ByVal pPaletteEntry As LongPtr, _
    ByVal RedGamma As Integer, _
    ByVal GreenGamma As Integer, _
    ByVal BlueGamma As Integer) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

HT_Get8BPPFormatPalette = ctypes.windll.gdi32.HT_Get8BPPFormatPalette
HT_Get8BPPFormatPalette.restype = ctypes.c_int
HT_Get8BPPFormatPalette.argtypes = [
    ctypes.c_void_p,  # pPaletteEntry : PALETTEENTRY* optional, out
    ctypes.c_ushort,  # RedGamma : WORD
    ctypes.c_ushort,  # GreenGamma : WORD
    ctypes.c_ushort,  # BlueGamma : WORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
HT_Get8BPPFormatPalette = Fiddle::Function.new(
  lib['HT_Get8BPPFormatPalette'],
  [
    Fiddle::TYPE_VOIDP,  # pPaletteEntry : PALETTEENTRY* optional, out
    -Fiddle::TYPE_SHORT,  # RedGamma : WORD
    -Fiddle::TYPE_SHORT,  # GreenGamma : WORD
    -Fiddle::TYPE_SHORT,  # BlueGamma : WORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "gdi32")]
extern "system" {
    fn HT_Get8BPPFormatPalette(
        pPaletteEntry: *mut PALETTEENTRY,  // PALETTEENTRY* optional, out
        RedGamma: u16,  // WORD
        GreenGamma: u16,  // WORD
        BlueGamma: u16  // WORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("GDI32.dll")]
public static extern int HT_Get8BPPFormatPalette(IntPtr pPaletteEntry, ushort RedGamma, ushort GreenGamma, ushort BlueGamma);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_HT_Get8BPPFormatPalette' -Namespace Win32 -PassThru
# $api::HT_Get8BPPFormatPalette(pPaletteEntry, RedGamma, GreenGamma, BlueGamma)
#uselib "GDI32.dll"
#func global HT_Get8BPPFormatPalette "HT_Get8BPPFormatPalette" sptr, sptr, sptr, sptr
; HT_Get8BPPFormatPalette varptr(pPaletteEntry), RedGamma, GreenGamma, BlueGamma   ; 戻り値は stat
; pPaletteEntry : PALETTEENTRY* optional, out -> "sptr"
; RedGamma : WORD -> "sptr"
; GreenGamma : WORD -> "sptr"
; BlueGamma : WORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "GDI32.dll"
#cfunc global HT_Get8BPPFormatPalette "HT_Get8BPPFormatPalette" var, int, int, int
; res = HT_Get8BPPFormatPalette(pPaletteEntry, RedGamma, GreenGamma, BlueGamma)
; pPaletteEntry : PALETTEENTRY* optional, out -> "var"
; RedGamma : WORD -> "int"
; GreenGamma : WORD -> "int"
; BlueGamma : WORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT HT_Get8BPPFormatPalette(PALETTEENTRY* pPaletteEntry, WORD RedGamma, WORD GreenGamma, WORD BlueGamma)
#uselib "GDI32.dll"
#cfunc global HT_Get8BPPFormatPalette "HT_Get8BPPFormatPalette" var, int, int, int
; res = HT_Get8BPPFormatPalette(pPaletteEntry, RedGamma, GreenGamma, BlueGamma)
; pPaletteEntry : PALETTEENTRY* optional, out -> "var"
; RedGamma : WORD -> "int"
; GreenGamma : WORD -> "int"
; BlueGamma : WORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procHT_Get8BPPFormatPalette = gdi32.NewProc("HT_Get8BPPFormatPalette")
)

// pPaletteEntry (PALETTEENTRY* optional, out), RedGamma (WORD), GreenGamma (WORD), BlueGamma (WORD)
r1, _, err := procHT_Get8BPPFormatPalette.Call(
	uintptr(pPaletteEntry),
	uintptr(RedGamma),
	uintptr(GreenGamma),
	uintptr(BlueGamma),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function HT_Get8BPPFormatPalette(
  pPaletteEntry: Pointer;   // PALETTEENTRY* optional, out
  RedGamma: Word;   // WORD
  GreenGamma: Word;   // WORD
  BlueGamma: Word   // WORD
): Integer; stdcall;
  external 'GDI32.dll' name 'HT_Get8BPPFormatPalette';
result := DllCall("GDI32\HT_Get8BPPFormatPalette"
    , "Ptr", pPaletteEntry   ; PALETTEENTRY* optional, out
    , "UShort", RedGamma   ; WORD
    , "UShort", GreenGamma   ; WORD
    , "UShort", BlueGamma   ; WORD
    , "Int")   ; return: INT
●HT_Get8BPPFormatPalette(pPaletteEntry, RedGamma, GreenGamma, BlueGamma) = DLL("GDI32.dll", "int HT_Get8BPPFormatPalette(void*, int, int, int)")
# 呼び出し: HT_Get8BPPFormatPalette(pPaletteEntry, RedGamma, GreenGamma, BlueGamma)
# pPaletteEntry : PALETTEENTRY* optional, out -> "void*"
# RedGamma : WORD -> "int"
# GreenGamma : WORD -> "int"
# BlueGamma : WORD -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "gdi32" fn HT_Get8BPPFormatPalette(
    pPaletteEntry: [*c]PALETTEENTRY, // PALETTEENTRY* optional, out
    RedGamma: u16, // WORD
    GreenGamma: u16, // WORD
    BlueGamma: u16 // WORD
) callconv(std.os.windows.WINAPI) i32;
proc HT_Get8BPPFormatPalette(
    pPaletteEntry: ptr PALETTEENTRY,  # PALETTEENTRY* optional, out
    RedGamma: uint16,  # WORD
    GreenGamma: uint16,  # WORD
    BlueGamma: uint16  # WORD
): int32 {.importc: "HT_Get8BPPFormatPalette", stdcall, dynlib: "GDI32.dll".}
pragma(lib, "gdi32");
extern(Windows)
int HT_Get8BPPFormatPalette(
    PALETTEENTRY* pPaletteEntry,   // PALETTEENTRY* optional, out
    ushort RedGamma,   // WORD
    ushort GreenGamma,   // WORD
    ushort BlueGamma   // WORD
);
ccall((:HT_Get8BPPFormatPalette, "GDI32.dll"), stdcall, Int32,
      (Ptr{PALETTEENTRY}, UInt16, UInt16, UInt16),
      pPaletteEntry, RedGamma, GreenGamma, BlueGamma)
# pPaletteEntry : PALETTEENTRY* optional, out -> Ptr{PALETTEENTRY}
# RedGamma : WORD -> UInt16
# GreenGamma : WORD -> UInt16
# BlueGamma : WORD -> UInt16
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t HT_Get8BPPFormatPalette(
    void* pPaletteEntry,
    uint16_t RedGamma,
    uint16_t GreenGamma,
    uint16_t BlueGamma);
]]
local gdi32 = ffi.load("gdi32")
-- gdi32.HT_Get8BPPFormatPalette(pPaletteEntry, RedGamma, GreenGamma, BlueGamma)
-- pPaletteEntry : PALETTEENTRY* optional, out
-- RedGamma : WORD
-- GreenGamma : WORD
-- BlueGamma : WORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('GDI32.dll');
const HT_Get8BPPFormatPalette = lib.func('__stdcall', 'HT_Get8BPPFormatPalette', 'int32_t', ['void *', 'uint16_t', 'uint16_t', 'uint16_t']);
// HT_Get8BPPFormatPalette(pPaletteEntry, RedGamma, GreenGamma, BlueGamma)
// pPaletteEntry : PALETTEENTRY* optional, out -> 'void *'
// RedGamma : WORD -> 'uint16_t'
// GreenGamma : WORD -> 'uint16_t'
// BlueGamma : WORD -> 'uint16_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("GDI32.dll", {
  HT_Get8BPPFormatPalette: { parameters: ["pointer", "u16", "u16", "u16"], result: "i32" },
});
// lib.symbols.HT_Get8BPPFormatPalette(pPaletteEntry, RedGamma, GreenGamma, BlueGamma)
// pPaletteEntry : PALETTEENTRY* optional, out -> "pointer"
// RedGamma : WORD -> "u16"
// GreenGamma : WORD -> "u16"
// BlueGamma : WORD -> "u16"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t HT_Get8BPPFormatPalette(
    void* pPaletteEntry,
    uint16_t RedGamma,
    uint16_t GreenGamma,
    uint16_t BlueGamma);
C, "GDI32.dll");
// $ffi->HT_Get8BPPFormatPalette(pPaletteEntry, RedGamma, GreenGamma, BlueGamma);
// pPaletteEntry : PALETTEENTRY* optional, out
// RedGamma : WORD
// GreenGamma : WORD
// BlueGamma : WORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Gdi32 extends StdCallLibrary {
    Gdi32 INSTANCE = Native.load("gdi32", Gdi32.class);
    int HT_Get8BPPFormatPalette(
        Pointer pPaletteEntry,   // PALETTEENTRY* optional, out
        short RedGamma,   // WORD
        short GreenGamma,   // WORD
        short BlueGamma   // WORD
    );
}
@[Link("gdi32")]
lib LibGDI32
  fun HT_Get8BPPFormatPalette = HT_Get8BPPFormatPalette(
    pPaletteEntry : PALETTEENTRY*,   # PALETTEENTRY* optional, out
    RedGamma : UInt16,   # WORD
    GreenGamma : UInt16,   # WORD
    BlueGamma : UInt16   # WORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef HT_Get8BPPFormatPaletteNative = Int32 Function(Pointer<Void>, Uint16, Uint16, Uint16);
typedef HT_Get8BPPFormatPaletteDart = int Function(Pointer<Void>, int, int, int);
final HT_Get8BPPFormatPalette = DynamicLibrary.open('GDI32.dll')
    .lookupFunction<HT_Get8BPPFormatPaletteNative, HT_Get8BPPFormatPaletteDart>('HT_Get8BPPFormatPalette');
// pPaletteEntry : PALETTEENTRY* optional, out -> Pointer<Void>
// RedGamma : WORD -> Uint16
// GreenGamma : WORD -> Uint16
// BlueGamma : WORD -> Uint16
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function HT_Get8BPPFormatPalette(
  pPaletteEntry: Pointer;   // PALETTEENTRY* optional, out
  RedGamma: Word;   // WORD
  GreenGamma: Word;   // WORD
  BlueGamma: Word   // WORD
): Integer; stdcall;
  external 'GDI32.dll' name 'HT_Get8BPPFormatPalette';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "HT_Get8BPPFormatPalette"
  c_HT_Get8BPPFormatPalette :: Ptr () -> Word16 -> Word16 -> Word16 -> IO Int32
-- pPaletteEntry : PALETTEENTRY* optional, out -> Ptr ()
-- RedGamma : WORD -> Word16
-- GreenGamma : WORD -> Word16
-- BlueGamma : WORD -> Word16
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let ht_get8bppformatpalette =
  foreign "HT_Get8BPPFormatPalette"
    ((ptr void) @-> uint16_t @-> uint16_t @-> uint16_t @-> returning int32_t)
(* pPaletteEntry : PALETTEENTRY* optional, out -> (ptr void) *)
(* RedGamma : WORD -> uint16_t *)
(* GreenGamma : WORD -> uint16_t *)
(* BlueGamma : WORD -> uint16_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library gdi32 (t "GDI32.dll"))
(cffi:use-foreign-library gdi32)

(cffi:defcfun ("HT_Get8BPPFormatPalette" ht-get8-bppformat-palette :convention :stdcall) :int32
  (p-palette-entry :pointer)   ; PALETTEENTRY* optional, out
  (red-gamma :uint16)   ; WORD
  (green-gamma :uint16)   ; WORD
  (blue-gamma :uint16))   ; WORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $HT_Get8BPPFormatPalette = Win32::API::More->new('GDI32',
    'int HT_Get8BPPFormatPalette(LPVOID pPaletteEntry, WORD RedGamma, WORD GreenGamma, WORD BlueGamma)');
# my $ret = $HT_Get8BPPFormatPalette->Call($pPaletteEntry, $RedGamma, $GreenGamma, $BlueGamma);
# pPaletteEntry : PALETTEENTRY* optional, out -> LPVOID
# RedGamma : WORD -> WORD
# GreenGamma : WORD -> WORD
# BlueGamma : WORD -> WORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型