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

glStencilFunc

関数
ステンシルテストの比較関数と参照値を設定する。
DLLOPENGL32.dll呼出規約winapi

シグネチャ

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

void glStencilFunc(
    DWORD func,
    INT ref,
    DWORD mask
);

パラメーター

名前方向説明
funcDWORDinステンシルテストの比較関数。GL_NEVER、GL_LESS、GL_ALWAYSなどを指定する。
refINTinテストの参照値。maskでマスクされた後の値と比較される。
maskDWORDin比較時に参照値とステンシル値の双方へ適用するビットマスク。

戻り値の型: void

各言語での呼び出し定義

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

void glStencilFunc(
    DWORD func,
    INT ref,
    DWORD mask
);
[DllImport("OPENGL32.dll", ExactSpelling = true)]
static extern void glStencilFunc(
    uint func,   // DWORD
    int ref,   // INT
    uint mask   // DWORD
);
<DllImport("OPENGL32.dll", ExactSpelling:=True)>
Public Shared Sub glStencilFunc(
    func As UInteger,   ' DWORD
    ref As Integer,   ' INT
    mask As UInteger   ' DWORD
)
End Sub
' func : DWORD
' ref : INT
' mask : DWORD
Declare PtrSafe Sub glStencilFunc Lib "opengl32" ( _
    ByVal func As Long, _
    ByVal ref As Long, _
    ByVal mask As Long)
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

glStencilFunc = ctypes.windll.opengl32.glStencilFunc
glStencilFunc.restype = None
glStencilFunc.argtypes = [
    wintypes.DWORD,  # func : DWORD
    ctypes.c_int,  # ref : INT
    wintypes.DWORD,  # mask : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OPENGL32.dll')
glStencilFunc = Fiddle::Function.new(
  lib['glStencilFunc'],
  [
    -Fiddle::TYPE_INT,  # func : DWORD
    Fiddle::TYPE_INT,  # ref : INT
    -Fiddle::TYPE_INT,  # mask : DWORD
  ],
  Fiddle::TYPE_VOID)
#[link(name = "opengl32")]
extern "system" {
    fn glStencilFunc(
        func: u32,  // DWORD
        ref: i32,  // INT
        mask: u32  // DWORD
    );
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("OPENGL32.dll")]
public static extern void glStencilFunc(uint func, int ref, uint mask);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OPENGL32_glStencilFunc' -Namespace Win32 -PassThru
# $api::glStencilFunc(func, ref, mask)
#uselib "OPENGL32.dll"
#func global glStencilFunc "glStencilFunc" sptr, sptr, sptr
; glStencilFunc func, ref, mask
; func : DWORD -> "sptr"
; ref : INT -> "sptr"
; mask : DWORD -> "sptr"
#uselib "OPENGL32.dll"
#func global glStencilFunc "glStencilFunc" int, int, int
; glStencilFunc func, ref, mask
; func : DWORD -> "int"
; ref : INT -> "int"
; mask : DWORD -> "int"
; void glStencilFunc(DWORD func, INT ref, DWORD mask)
#uselib "OPENGL32.dll"
#func global glStencilFunc "glStencilFunc" int, int, int
; glStencilFunc func, ref, mask
; func : DWORD -> "int"
; ref : INT -> "int"
; mask : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	opengl32 = windows.NewLazySystemDLL("OPENGL32.dll")
	procglStencilFunc = opengl32.NewProc("glStencilFunc")
)

// func (DWORD), ref (INT), mask (DWORD)
r1, _, err := procglStencilFunc.Call(
	uintptr(func),
	uintptr(ref),
	uintptr(mask),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // void
procedure glStencilFunc(
  func: DWORD;   // DWORD
  ref: Integer;   // INT
  mask: DWORD   // DWORD
); stdcall;
  external 'OPENGL32.dll' name 'glStencilFunc';
result := DllCall("OPENGL32\glStencilFunc"
    , "UInt", func   ; DWORD
    , "Int", ref   ; INT
    , "UInt", mask   ; DWORD
    , "Int")   ; return: void
●glStencilFunc(func, ref, mask) = DLL("OPENGL32.dll", "int glStencilFunc(dword, int, dword)")
# 呼び出し: glStencilFunc(func, ref, mask)
# func : DWORD -> "dword"
# ref : INT -> "int"
# mask : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "opengl32" fn glStencilFunc(
    func: u32, // DWORD
    ref: i32, // INT
    mask: u32 // DWORD
) callconv(std.os.windows.WINAPI) void;
proc glStencilFunc(
    `func`: uint32,  # DWORD
    `ref`: int32,  # INT
    mask: uint32  # DWORD
) {.importc: "glStencilFunc", stdcall, dynlib: "OPENGL32.dll".}
pragma(lib, "opengl32");
extern(Windows)
void glStencilFunc(
    uint func,   // DWORD
    int ref,   // INT
    uint mask   // DWORD
);
ccall((:glStencilFunc, "OPENGL32.dll"), stdcall, Cvoid,
      (UInt32, Int32, UInt32),
      func, ref, mask)
# func : DWORD -> UInt32
# ref : INT -> Int32
# mask : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void glStencilFunc(
    uint32_t func,
    int32_t ref,
    uint32_t mask);
]]
local opengl32 = ffi.load("opengl32")
-- opengl32.glStencilFunc(func, ref, mask)
-- func : DWORD
-- ref : INT
-- mask : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('OPENGL32.dll');
const glStencilFunc = lib.func('__stdcall', 'glStencilFunc', 'void', ['uint32_t', 'int32_t', 'uint32_t']);
// glStencilFunc(func, ref, mask)
// func : DWORD -> 'uint32_t'
// ref : INT -> 'int32_t'
// mask : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("OPENGL32.dll", {
  glStencilFunc: { parameters: ["u32", "i32", "u32"], result: "void" },
});
// lib.symbols.glStencilFunc(func, ref, mask)
// func : DWORD -> "u32"
// ref : INT -> "i32"
// mask : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void glStencilFunc(
    uint32_t func,
    int32_t ref,
    uint32_t mask);
C, "OPENGL32.dll");
// $ffi->glStencilFunc(func, ref, mask);
// func : DWORD
// ref : INT
// mask : DWORD
// 構造体/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 Opengl32 extends StdCallLibrary {
    Opengl32 INSTANCE = Native.load("opengl32", Opengl32.class);
    void glStencilFunc(
        int func,   // DWORD
        int ref,   // INT
        int mask   // DWORD
    );
}
@[Link("opengl32")]
lib LibOPENGL32
  fun glStencilFunc = glStencilFunc(
    func : UInt32,   # DWORD
    ref : Int32,   # INT
    mask : UInt32   # DWORD
  ) : Void
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef glStencilFuncNative = Void Function(Uint32, Int32, Uint32);
typedef glStencilFuncDart = void Function(int, int, int);
final glStencilFunc = DynamicLibrary.open('OPENGL32.dll')
    .lookupFunction<glStencilFuncNative, glStencilFuncDart>('glStencilFunc');
// func : DWORD -> Uint32
// ref : INT -> Int32
// mask : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
procedure glStencilFunc(
  func: DWORD;   // DWORD
  ref: Integer;   // INT
  mask: DWORD   // DWORD
); stdcall;
  external 'OPENGL32.dll' name 'glStencilFunc';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "glStencilFunc"
  c_glStencilFunc :: Word32 -> Int32 -> Word32 -> IO ()
-- func : DWORD -> Word32
-- ref : INT -> Int32
-- mask : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let glstencilfunc =
  foreign "glStencilFunc"
    (uint32_t @-> int32_t @-> uint32_t @-> returning void)
(* func : DWORD -> uint32_t *)
(* ref : INT -> int32_t *)
(* mask : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library opengl32 (t "OPENGL32.dll"))
(cffi:use-foreign-library opengl32)

(cffi:defcfun ("glStencilFunc" gl-stencil-func :convention :stdcall) :void
  (func :uint32)   ; DWORD
  (ref :int32)   ; INT
  (mask :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $glStencilFunc = Win32::API::More->new('OPENGL32',
    'void glStencilFunc(DWORD func, int ref, DWORD mask)');
# my $ret = $glStencilFunc->Call($func, $ref, $mask);
# func : DWORD -> DWORD
# ref : INT -> int
# mask : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。