SetViewportOrgEx

関数

ビューポートの原点を設定する。

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

シグネチャ

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

BOOL SetViewportOrgEx(
    HDC hdc,
    INT x,
    INT y,
    POINT* lppt   // optional
);

パラメーター

名前	型	方向	説明
hdc	HDC	in	デバイスコンテキストへのハンドル。
x	INT	in	新しいビューポート原点の x 座標(デバイス単位)。
y	INT	in	新しいビューポート原点の y 座標(デバイス単位)。
lppt	POINT*	outoptional	以前のビューポート原点をデバイス座標で受け取る POINT 構造体へのポインター。lpPoint が NULL の場合、このパラメーターは使用されません。

戻り値の型: BOOL

公式ドキュメント

SetViewportOrgEx 関数は、どのデバイス座標上の点がウィンドウ原点 (0,0) にマップされるかを指定します。

戻り値

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

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

解説(Remarks)

この関数は(SetViewportExtEx および SetWindowExtEx とともに)、論理座標空間(ウィンドウとも呼ばれます)からデバイス座標空間(ビューポート)へのマッピングを定義するのに役立ちます。SetViewportOrgEx は、どのデバイス座標上の点が論理座標 (0,0) にマップされるかを指定します。これは、論理座標 (0,0) が左上隅を指さないように軸を移動する効果があります。


//map the logical point (0,0) to the device point (xViewOrg, yViewOrg) 
SetViewportOrgEx ( hdc, xViewOrg, yViewOrg, NULL)

これは SetWindowOrgEx 関数に関連しています。通常は、どちらか一方の関数を使用し、両方を使用することはありません。SetWindowOrgEx と SetViewportOrgEx の使用に関わらず、デバイス座標 (0,0) は常に左上隅です。

例

例については、Redrawing in the Update Region を参照してください。

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

各言語での呼び出し定義

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

BOOL SetViewportOrgEx(
    HDC hdc,
    INT x,
    INT y,
    POINT* lppt   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern bool SetViewportOrgEx(
    IntPtr hdc,   // HDC
    int x,   // INT
    int y,   // INT
    IntPtr lppt   // POINT* optional, out
);

<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function SetViewportOrgEx(
    hdc As IntPtr,   ' HDC
    x As Integer,   ' INT
    y As Integer,   ' INT
    lppt As IntPtr   ' POINT* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hdc : HDC
' x : INT
' y : INT
' lppt : POINT* optional, out
Declare PtrSafe Function SetViewportOrgEx Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal x As Long, _
    ByVal y As Long, _
    ByVal lppt As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SetViewportOrgEx = ctypes.windll.gdi32.SetViewportOrgEx
SetViewportOrgEx.restype = wintypes.BOOL
SetViewportOrgEx.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    ctypes.c_int,  # x : INT
    ctypes.c_int,  # y : INT
    ctypes.c_void_p,  # lppt : POINT* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
SetViewportOrgEx = Fiddle::Function.new(
  lib['SetViewportOrgEx'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_INT,  # x : INT
    Fiddle::TYPE_INT,  # y : INT
    Fiddle::TYPE_VOIDP,  # lppt : POINT* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn SetViewportOrgEx(
        hdc: *mut core::ffi::c_void,  // HDC
        x: i32,  // INT
        y: i32,  // INT
        lppt: *mut POINT  // POINT* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll")]
public static extern bool SetViewportOrgEx(IntPtr hdc, int x, int y, IntPtr lppt);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_SetViewportOrgEx' -Namespace Win32 -PassThru
# $api::SetViewportOrgEx(hdc, x, y, lppt)

#uselib "GDI32.dll"
#func global SetViewportOrgEx "SetViewportOrgEx" sptr, sptr, sptr, sptr
; SetViewportOrgEx hdc, x, y, varptr(lppt)   ; 戻り値は stat
; hdc : HDC -> "sptr"
; x : INT -> "sptr"
; y : INT -> "sptr"
; lppt : POINT* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "GDI32.dll"
#cfunc global SetViewportOrgEx "SetViewportOrgEx" sptr, int, int, var
; res = SetViewportOrgEx(hdc, x, y, lppt)
; hdc : HDC -> "sptr"
; x : INT -> "int"
; y : INT -> "int"
; lppt : POINT* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "GDI32.dll"
#cfunc global SetViewportOrgEx "SetViewportOrgEx" sptr, int, int, sptr
; res = SetViewportOrgEx(hdc, x, y, varptr(lppt))
; hdc : HDC -> "sptr"
; x : INT -> "int"
; y : INT -> "int"
; lppt : POINT* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。