Window
ウィンドウの作成、削除、イベント・ポーリングなど、ウィンドウに関連する関数やタイプのリファレンス・ドキュメントです。より詳細な情報については、Windowガイドを参照してください。
マクロ
| 名前 | 説明 |
|---|---|
| GLFW_FOCUSED | 入力フォーカスウィンドウのヒントと属性。 |
| GLFW_ICONIFIED | ウィンドウのアイコン化ウィンドウ属性。 |
| GLFW_RESIZABLE | ウィンドウのリサイズが可能なウィンドウのヒントと属性。 |
| GLFW_VISIBLE | Window visibility ウィンドウのヒントと属性。 |
| GLFW_DECORATED | ウィンドウの装飾 ウィンドウのヒントと属性 |
| GLFW_AUTO_ICONIFY | ウィンドウの自動アイコン化のヒントと属性。 |
| GLFW_FLOATING | ウィンドウの装飾 ウィンドウのヒントと属性 |
| GLFW_MAXIMIZED | ウィンドウの最大化のヒントと属性。 |
| GLFW_CENTER_CURSOR | カーソルのセンタリングウィンドウのヒント。 |
| GLFW_TRANSPARENT_FRAMEBUFFER | ウィンドウのフレームバッファの透明度のヒントと属性。 |
| GLFW_HOVERED | マウスカーソルのホバーウィンドウ属性。 |
| GLFW_FOCUS_ON_SHOW | ショーウィンドウのヒントと属性を呼び出す際にフォーカスを入力する。 |
| GLFW_RED_BITS | フレームバッファのビット深度のヒント。 |
| GLFW_GREEN_BITS | フレームバッファのビット深度のヒント。 |
| GLFW_BLUE_BITS | フレームバッファのビット深度のヒント。 |
| GLFW_ALPHA_BITS | フレームバッファのビット深度のヒント。 |
| GLFW_DEPTH_BITS | フレームバッファのビット深度のヒント。 |
| GLFW_STENCIL_BITS | フレームバッファのビット深度のヒント。 |
| GLFW_ACCUM_RED_BITS | フレームバッファのビット深度のヒント。 |
| GLFW_ACCUM_GREEN_BITS | フレームバッファのビット深度のヒント。 |
| GLFW_ACCUM_BLUE_BITS | フレームバッファのビット深度のヒント。 |
| GLFW_ACCUM_ALPHA_BITS | フレームバッファのビット深度のヒント。 |
| GLFW_AUX_BUFFERS | フレームバッファ補助バッファのヒント。 |
| GLFW_STEREO | OpenGL ステレオスコピックレンダリングのヒント。 |
| GLFW_SAMPLES | フレームバッファMSAAサンプルのヒント。 |
| GLFW_SRGB_CAPABLE | フレームバッファのsRGBヒント。 |
| GLFW_REFRESH_RATE | モニターのリフレッシュレートのヒント。 |
| GLFW_DOUBLEBUFFER | フレームバッファのダブルバッファリングのヒント。 |
| GLFW_CLIENT_API | コンテキスト・クライアント API のヒントと属性。 |
| GLFW_CONTEXT_VERSION_MAJOR | コンテキストクライアントAPIのメジャーバージョンのヒントと属性。 |
| GLFW_CONTEXT_VERSION_MINOR | コンテキストクライアントAPIのマイナーバージョンのヒントと属性。 |
| GLFW_CONTEXT_REVISION | コンテキスト・クライアントAPIのリビジョン番号属性。 |
| GLFW_CONTEXT_ROBUSTNESS | コンテキストの堅牢性のヒントと属性。 |
| GLFW_OPENGL_FORWARD_COMPAT | OpenGLの前方互換性のヒントと属性。 |
| GLFW_OPENGL_DEBUG_CONTEXT | デバッグモードのコンテキストヒントと属性。 |
| GLFW_OPENGL_PROFILE | OpenGLプロファイルのヒントと属性。 |
| GLFW_CONTEXT_RELEASE_BEHAVIOR | コンテキストのフラッシュオンリリースのヒントと属性。 |
| GLFW_CONTEXT_NO_ERROR | コンテキストエラー抑制のヒントと属性。 |
| GLFW_CONTEXT_CREATION_API | コンテキスト作成APIのヒントと属性。 |
| GLFW_SCALE_TO_MONITOR | ウィンドウ内容領域のスケーリングウィンドウウィンドウのヒント。 |
| GLFW_COCOA_RETINA_FRAMEBUFFER | macOS固有のウィンドウヒント。 |
| GLFW_COCOA_FRAME_NAME | macOS固有のウィンドウヒント。 |
| GLFW_COCOA_GRAPHICS_SWITCHING | macOS固有のウィンドウヒント。 |
| GLFW_X11_CLASS_NAME | X11固有のウィンドウヒント。 |
| GLFW_X11_INSTANCE_NAME | X11固有のウィンドウヒント。 |
GLFW_FOCUSED
入力フォーカスのウィンドウヒントまたはウィンドウ属性。
#define GLFW_FOCUSED 0x00020001GLFW_ICONIFIED
ウィンドウのアイコン化ウィンドウ属性。
#define GLFW_ICONIFIED 0x00020002GLFW_RESIZABLE
ウィンドウのサイズ変更可能なウィンドウヒントとウィンドウ属性。
#define GLFW_RESIZABLE 0x00020003GLFW_VISIBLE
ウィンドウの可視性ウィンドウのヒントとウィンドウの属性。
#define GLFW_VISIBLE 0x00020004GLFW_DECORATED
ウィンドウの装飾 ウィンドウのヒントとウィンドウの属性。
#define GLFW_DECORATED 0x00020005GLFW_AUTO_ICONIFY
ウィンドウの自動アイコン化ウィンドウヒントとウィンドウ属性。
#define GLFW_AUTO_ICONIFY 0x00020006GLFW_FLOATING
ウィンドウの装飾 ウィンドウのヒントとウィンドウの属性。
#define GLFW_FLOATING 0x00020007GLFW_MAXIMIZED
ウィンドウの最大化ウィンドウヒントとウィンドウ属性。
#define GLFW_MAXIMIZED 0x00020008GLFW_CENTER_CURSOR
カーソルのセンタリングウィンドウのヒント。
#define GLFW_CENTER_CURSOR 0x00020009GLFW_TRANSPARENT_FRAMEBUFFER
ウィンドウ・フレームバッファの透明度ウィンドウ・ヒントとウィンドウ属性。
#define GLFW_TRANSPARENT_FRAMEBUFFER 0x0002000AGLFW_HOVERED
マウスカーソルのホバーウィンドウ属性。
#define GLFW_HOVERED 0x0002000BGLFW_FOCUS_ON_SHOW
入力フォーカスのウィンドウヒントまたはウィンドウ属性。
#define GLFW_FOCUS_ON_SHOW 0x0002000CGLFW_RED_BITS
フレームバッファのビット深度のヒント。
#define GLFW_RED_BITS 0x00021001GLFW_GREEN_BITS
フレームバッファのビット深度のヒント。
#define GLFW_GREEN_BITS 0x00021002GLFW_BLUE_BITS
フレームバッファのビット深度のヒント。
#define GLFW_BLUE_BITS 0x00021003GLFW_ALPHA_BITS
フレームバッファのビット深度のヒント。
#define GLFW_ALPHA_BITS 0x00021004GLFW_DEPTH_BITS
フレームバッファのビット深度のヒント。
#define GLFW_DEPTH_BITS 0x00021005GLFW_STENCIL_BITS
フレームバッファのビット深度のヒント。
#define GLFW_STENCIL_BITS 0x00021006GLFW_ACCUM_RED_BITS
フレームバッファのビット深度のヒント。
#define GLFW_ACCUM_RED_BITS 0x00021007GLFW_ACCUM_GREEN_BITS
フレームバッファのビット深度のヒント。
#define GLFW_ACCUM_GREEN_BITS 0x00021008GLFW_ACCUM_BLUE_BITS
フレームバッファのビット深度のヒント。
#define GLFW_ACCUM_BLUE_BITS 0x00021009GLFW_ACCUM_ALPHA_BITS
フレームバッファのビット深度のヒント。
#define GLFW_ACCUM_ALPHA_BITS 0x0002100AGLFW_AUX_BUFFERS
フレームバッファ補助バッファのヒント。
#define GLFW_AUX_BUFFERS 0x0002100BGLFW_STEREO
OpenGL ステレオスコピックレンダリングのヒント。
#define GLFW_STEREO 0x0002100CGLFW_SAMPLES
フレームバッファMSAAサンプルのヒント。
#define GLFW_SAMPLES 0x0002100DGLFW_SRGB_CAPABLE
フレームバッファのsRGBヒント。
#define GLFW_SRGB_CAPABLE 0x0002100EGLFW_REFRESH_RATE
モニターのリフレッシュレートのヒント。
#define GLFW_REFRESH_RATE 0x0002100FGLFW_DOUBLEBUFFER
フレームバッファのダブルバッファリングのヒント。
#define GLFW_DOUBLEBUFFER 0x00021010GLFW_CLIENT_API
コンテキスト・クライアント API のヒントと属性。
#define GLFW_CLIENT_API 0x00022001GLFW_CONTEXT_VERSION_MAJOR
コンテキストクライアントAPIのメジャーバージョンのヒントと属性。
#define GLFW_CONTEXT_VERSION_MAJOR 0x00022002GLFW_CONTEXT_VERSION_MINOR
コンテキストクライアントAPIのマイナーバージョンのヒントと属性。
#define GLFW_CONTEXT_VERSION_MINOR 0x00022003GLFW_CONTEXT_REVISION
コンテキスト・クライアントAPIのリビジョン番号属性。
#define GLFW_CONTEXT_REVISION 0x00022004GLFW_CONTEXT_ROBUSTNESS
コンテキスト・クライアントAPIのリビジョン番号のヒントと属性。
#define GLFW_CONTEXT_ROBUSTNESS 0x00022005GLFW_OPENGL_FORWARD_COMPAT
OpenGLの前方互換性のヒントと属性。
#define GLFW_OPENGL_FORWARD_COMPAT 0x00022006GLFW_OPENGL_DEBUG_CONTEXT
デバッグモードのコンテキストヒントと属性。
#define GLFW_OPENGL_DEBUG_CONTEXT 0x00022007GLFW_OPENGL_PROFILE
OpenGLプロファイルのヒントと属性。
#define GLFW_OPENGL_PROFILE 0x00022008GLFW_CONTEXT_RELEASE_BEHAVIOR
コンテキストのフラッシュオンリリースのヒントと属性。
#define GLFW_CONTEXT_RELEASE_BEHAVIOR 0x00022009GLFW_CONTEXT_NO_ERROR
コンテキストエラー抑制のヒントと属性。
#define GLFW_CONTEXT_NO_ERROR 0x0002200AGLFW_CONTEXT_CREATION_API
コンテキスト作成APIのヒントと属性。
#define GLFW_CONTEXT_CREATION_API 0x0002200BGLFW_SCALE_TO_MONITOR
#define GLFW_SCALE_TO_MONITOR 0x0002200CGLFW_COCOA_RETINA_FRAMEBUFFER
#define GLFW_COCOA_RETINA_FRAMEBUFFER 0x00023001GLFW_COCOA_FRAME_NAME
#define GLFW_COCOA_FRAME_NAME 0x00023002GLFW_COCOA_GRAPHICS_SWITCHING
#define GLFW_COCOA_GRAPHICS_SWITCHING 0x00023003GLFW_X11_CLASS_NAME
#define GLFW_X11_CLASS_NAME 0x00024001GLFW_X11_INSTANCE_NAME
#define GLFW_X11_INSTANCE_NAME 0x00024002型定義
| 名前 | 説明 |
|---|---|
| struct GLFWwindow | 不透明なウィンドウオブジェクト。 |
| void(* GLFWwindowposfun) | ウィンドウ位置コールバックの関数ポインタタイプ。 |
| void(* GLFWwindowsizefun) | ウィンドウサイズ・コールバックの関数ポインタ型。 |
| void(* GLFWwindowclosefun) | ウィンドウを閉じるコールバックの関数ポインタの型。 |
| void(* GLFWwindowrefreshfun) | ウィンドウ内容更新コールバックの関数ポインタ型。 |
| void(* GLFWwindowfocusfun) | ウィンドウフォーカスコールバック用の関数ポインタタイプ。 |
| void(* GLFWwindowiconifyfun) | ウィンドウアイコン化コールバックの関数ポインタタイプ。 |
| void(* GLFWwindowmaximizefun) | ウィンドウ最大化コールバックの関数ポインタタイプ。 |
| void(* GLFWframebuffersizefun) | フレームバッファサイズコールバック用の関数ポインタタイプ。 |
| void(* GLFWwindowcontentscalefun) | ウィンドウコンテンツスケールコールバック用の関数ポインタタイプ。 |
| struct GLFWimage | 画像データ。 |
struct GLFWwindow
不透明なウィンドウオブジェクト。
typedef struct GLFWwindow GLFWwindow参照:
- Window objects
追加:
バージョン3.0で追加。
void(* GLFWwindowposfun)
これは、ウィンドウ位置コールバック用の関数ポインタ型である。ウィンドウ位置コールバック関数は以下のシグネチャを持ちます：
void callback_name(GLFWwindow* window, int xpos, int ypos)typedef void(* GLFWwindowposfun) (GLFWwindow *window, int xpos, int ypos)引数:
[in] window: 動かされたウィンドウ。[in] xpos: ウィンドウのコンテンツ領域の左上隅の、スクリーン座標での新しいx座標。[in] ypos: ウィンドウのコンテンツ領域の左上隅の、スクリーン座標での新しいy座標。
参照:
- Window position
- glfwSetWindowPosCallback
追加:
バージョン3.0で追加。
void(* GLFWwindowsizefun)
これは、ウィンドウサイズ・コールバック用の関数ポインタ型である。ウィンドウサイズ・コールバック関数は以下のシグネチャを持つ：
void callback_name(GLFWwindow* window, int width, int height)typedef void(* GLFWwindowsizefun) (GLFWwindow *window, int width, int height)引数:
[in] window: リサイズされたウィンドウ。[in] width: ウィンドウの新しい幅をスクリーン座標で指定する。[in] height: ウィンドウの新しい高さをスクリーン座標で指定する。
参照:
- Window size
- glfwSetWindowSizeCallback
追加:
バージョン1.0で追加。GLFW 3: ウィンドウハンドルパラメーターを追加。
void(* GLFWwindowclosefun)
これは、ウィンドウを閉じるコールバック用の関数ポインタ型である。ウィンドウを閉じるコールバック関数は以下のシグネチャを持つ：
void function_name(GLFWwindow* window)typedef void(* GLFWwindowclosefun) (GLFWwindow *window)引数:
[in] window: ユーザーが閉じようとしたウィンドウ。
参照:
- Window closing and close flag
- glfwSetWindowCloseCallback
追加:
バージョン2.5で追加。GLFW 3: ウィンドウハンドルパラメーターを追加。
void(* GLFWwindowrefreshfun)
これは、ウィンドウ・コンテンツ・リフレッシュ・コールバック用の関数ポインタ型である。ウィンドウ・コンテンツ更新コールバック関数は以下のシグネチャを持ちます：
void function_name(GLFWwindow* window);typedef void(* GLFWwindowrefreshfun) (GLFWwindow *window)引数:
[in] window: 内容を更新する必要があるウィンドウ。
参照:
- Window damage and refresh
- glfwSetWindowRefreshCallback
追加:
バージョン2.5で追加。GLFW 3: ウィンドウハンドルパラメーターを追加。
void(* GLFWwindowfocusfun)
これはウィンドウ・フォーカス・コールバック用の関数ポインタ型である。ウィンドウ・フォーカス・コールバック関数は以下のシグネチャを持ちます：
void function_name(GLFWwindow* window, int focused)typedef void(* GLFWwindowfocusfun) (GLFWwindow *window, int focused)引数:
[in] window: 入力フォーカスを得た、または失ったウィンドウ。[in] focused: ウィンドウに入力フォーカスが与えられた場合はGLFW_TRUE、失われた場合はGLFW_FALSE。
参照:
- Window input focus
- glfwSetWindowFocusCallback
追加:
バージョン3.0で追加。
void(* GLFWwindowiconifyfun)
これはウィンドウ・アイコニファイ・コールバック用の関数ポインタ型である。ウィンドウアイコニファイコールバック関数は以下のシグネチャを持ちます：
void function_name(GLFWwindow* window, int iconified)typedef void(* GLFWwindowiconifyfun) (GLFWwindow *window, int iconified)引数:
[in] window: アイコン化または復元されたウィンドウ。[in] iconified: ウィンドウがアイコン化された場合はGLFW_TRUE、復元された場合はGLFW_FALSE。
参照:
- Window iconification
- glfwSetWindowIconifyCallback
追加:
バージョン3.0で追加。
void(* GLFWwindowmaximizefun)
これは、ウィンドウの最大化コールバック用の関数ポインタ型である。ウィンドウ最大化コールバック関数のシグネチャは以下のとおりです：
void function_name(GLFWwindow* window, int maximized)typedef void(* GLFWwindowmaximizefun) (GLFWwindow *window, int maximized)引数:
[in] window: 最大化または復元されたウィンドウ。[in] maximized: ウィンドウが最大化された場合はGLFW_TRUE、復元された場合はGLFW_FALSE。
参照:
- Window maximization
- glfwSetWindowMaximizeCallback
追加:
バージョン3.3で追加。
void(* GLFWframebuffersizefun)
これは、フレームバッファ・サイズ・コールバック用の関数ポインタ型である。フレームバッファ・サイズ・コールバック関数は以下のシグネチャを持つ：
void function_name(GLFWwindow* window, int width, int height)typedef void(* GLFWframebuffersizefun) (GLFWwindow *window, int width, int height)引数:
[in] window: フレームバッファがリサイズされたウィンドウ。[in] width: フレームバッファの新しい幅（ピクセル単位）。[in] height: フレームバッファの新しい高さ（ピクセル単位）。
参照:
- Framebuffer size
- glfwSetFramebufferSizeCallback
追加:
バージョン3.0で追加。
void(* GLFWwindowcontentscalefun)
これは、ウィンドウコンテンツスケールコールバック用の関数ポインタタイプです。ウィンドウコンテンツスケールコールバック関数のシグネチャは次のとおりです：
void function_name(GLFWwindow* window, float xscale, float yscale)typedef void(* GLFWwindowcontentscalefun) (GLFWwindow *window, float xscale, float yscale)引数:
[in] window: 内容スケールが変更されたウィンドウ。[in] xscale: ウィンドウの新しいX軸の内容スケール。[in] yscale: ウィンドウの新しいY軸の内容スケール。
参照:
- Window content scale
- glfwSetWindowContentScaleCallback
追加:
バージョン3.3で追加。
struct GLFWimage
これは単一の2D画像を記述する。期待されるピクセルフォーマットは、各関数のドキュメントを参照してください。
typedef struct GLFWimage GLFWimage参照:
- Custom cursor creation
- Window icon
追加:
バージョン2.1で追加。GLFW 3: フォーマットとピクセルあたりのバイト数のメンバーを削除。
関数
| 関数名 | 説明 |
|---|---|
| glfwDefaultWindowHints | すべてのウィンドウヒントをデフォルト値にリセットする。 |
| glfwWindowHint | 指定されたウィンドウヒントを目的の値に設定する。 |
| glfwWindowHintString | 指定されたウィンドウヒントを目的の値に設定する。 |
| glfwCreateWindow | ウィンドウとそれに関連するコンテキストを作成します。 |
| glfwDestroyWindow | 指定されたウィンドウとそのコンテキストを破棄します。 |
| glfwWindowShouldClose | 指定されたウィンドウのクローズフラグをチェックする。 |
| glfwSetWindowShouldClose | 指定したウィンドウのクローズフラグを設定する。 |
| glfwSetWindowTitle | 指定したウィンドウのタイトルを設定します。 |
| glfwSetWindowIcon | 指定したウィンドウのアイコンを設定します。 |
| glfwGetWindowPos | 指定されたウィンドウのコンテンツ領域の位置を取得します。 |
| glfwSetWindowPos | 指定したウィンドウのコンテンツエリアの位置を設定します。 |
| glfwGetWindowSize | 指定されたウィンドウのコンテンツ領域のサイズを取得します。 |
| glfwSetWindowSizeLimits | 指定したウィンドウのサイズ制限を設定する。 |
| glfwSetWindowAspectRatio | 指定したウィンドウのアスペクト比を設定する。 |
| glfwSetWindowSize | 指定されたウィンドウのコンテンツ領域のサイズを設定します。 |
| glfwGetFramebufferSize | 指定されたウィンドウのフレームバッファのサイズを取得します。 |
| glfwGetWindowFrameSize | ウィンドウの枠のサイズを取得します。 |
| glfwGetWindowContentScale | 指定したウィンドウのコンテンツスケールを取得します。 |
| glfwGetWindowOpacity | ウィンドウ全体の不透明度を返します。 |
| glfwSetWindowOpacity | ウィンドウ全体の不透明度を設定する。 |
| glfwIconifyWindow | 指定したウィンドウをアイコン化する。 |
| glfwRestoreWindow | 指定したウィンドウを復元する。 |
| glfwMaximizeWindow | 指定したウィンドウを最大化する。 |
| glfwShowWindow | 指定したウィンドウを表示する。 |
| glfwHideWindow | 指定したウィンドウを非表示にします。 |
| glfwFocusWindow | 指定したウィンドウを前面に出し、入力フォーカスを設定する。 |
| glfwRequestWindowAttention | 指定されたウィンドウにユーザーの注意を促す。 |
| glfwGetWindowMonitor | ウィンドウがフルスクリーンモードで使用するモニターを返します。 |
| glfwSetWindowMonitor | ウィンドウのモード、モニター、ビデオモード、配置を設定する。 |
| glfwGetWindowAttrib | 指定されたウィンドウの属性を返します。 |
| glfwSetWindowAttrib | 指定したウィンドウの属性を設定します。 |
| glfwSetWindowUserPointer | 指定したウィンドウのユーザーポインターを設定します。 |
| glfwGetWindowUserPointer | 指定されたウィンドウのユーザーポインタを返します。 |
| glfwSetWindowPosCallback | 指定したウィンドウの位置コールバックを設定します。 |
| glfwSetWindowSizeCallback | 指定したウィンドウのサイズ・コールバックを設定します。 |
| glfwSetWindowCloseCallback | 指定したウィンドウのクローズ・コールバックを設定します。 |
| glfwSetWindowRefreshCallback | 指定したウィンドウのリフレッシュ・コールバックを設定します。 |
| glfwSetWindowFocusCallback | 指定したウィンドウのフォーカス・コールバックを設定します。 |
| glfwSetWindowIconifyCallback | 指定したウィンドウのiconifyコールバックを設定します。 |
| glfwSetWindowMaximizeCallback | 指定したウィンドウの最大化コールバックを設定します。 |
| glfwSetFramebufferSizeCallback | 指定したウィンドウのフレームバッファ・リサイズ・コールバックを設定します。 |
| glfwSetWindowContentScaleCallback | 指定したウィンドウのコンテンツ・スケールのコールバックを設定します。 |
| glfwPollEvents | 保留中のすべてのイベントを処理する。 |
| glfwWaitEvents | イベントがキューに入るまで待機し、イベントを処理する。 |
| glfwWaitEventsTimeout | イベントがキューに入るまでタイムアウトで待機し、イベントを処理する。 |
| glfwPostEmptyEvent | 空のイベントをイベントキューに投稿する。 |
| glfwSwapBuffers | 指定したウィンドウのフロントバッファとバックバッファを入れ替える。 |
glfwDefaultWindowHints()
この関数は、すべてのウィンドウヒントをデフォルト値にリセットする。
void glfwDefaultWindowHints(void)エラー:
考えられるエラーはGLFW_NOT_INITIALIZED。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Window creation hints
- glfwWindowHint
- glfwWindowHintString
追加:
バージョン3.0で追加。
glfwWindowHint()
この関数は、次に glfwCreateWindow を呼び出すときのヒントを設定する。一度設定されたヒントは、この関数または glfwDefaultWindowHints の呼び出しによって変更されるか、ライブラリが終了するまで、その値を保持します。
この関数で設定できるヒントは整数値のみです。文字列値のヒントは glfwWindowHintString で設定します。
この関数は、指定されたヒント値が有効かどうかをチェックしません。ヒントに無効な値を設定した場合、代わりに次の glfwCreateWindow 呼び出しで報告されます。
いくつかのヒントはプラットフォーム固有です。これらはどのプラットフォームでも設定できますが、特定のプラットフォームにのみ影響します。他のプラットフォームでは無視されます。これらのヒントを設定するのに、プラットフォーム固有のヘッダーや関数は必要ありません。
void glfwWindowHint(int hint, int value)引数:
[in] hint: 設定するウィンドウのヒント。[in] value: ウィンドウヒントの新しい値。
エラー:
起こりうるエラーは GLFW_NOT_INITIALIZED と GLFW_INVALID_ENUM である。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Window creation hints
- glfwWindowHintString
- glfwDefaultWindowHints
追加:
バージョン 3.0 で追加されました。glfwOpenWindowHint を置き換えます。
glfwWindowHintString()
この関数は、次に glfwCreateWindow を呼び出すときのヒントを設定する。一度設定されたヒントは、この関数または glfwDefaultWindowHints の呼び出しによって変更されるか、ライブラリが終了するまで、その値を保持します。
この関数で設定できるヒントは文字列型のみです。整数値のヒントは glfwWindowHint で設定します。
この関数は、指定されたヒント値が有効かどうかをチェックしません。ヒントに無効な値を設定した場合、代わりに次の glfwCreateWindow 呼び出しで報告されます。
いくつかのヒントはプラットフォーム固有です。これらはどのプラットフォームでも設定できますが、特定のプラットフォームにのみ影響します。他のプラットフォームでは無視されます。これらのヒントを設定するのに、プラットフォーム固有のヘッダーや関数は必要ありません。
void glfwWindowHintString(int hint, const char * value)引数:
[in] hint: 設定するウィンドウのヒント。[in] value: ウィンドウヒントの新しい値。
エラー:
起こりうるエラーは GLFW_NOT_INITIALIZED と GLFW_INVALID_ENUM である。
ポインタの寿命:
指定された文字列は、この関数が戻る前にコピーされる。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Window creation hints
- glfwWindowHint
- glfwDefaultWindowHints
追加:
バージョン3.3で追加。
glfwCreateWindow()
この関数はウィンドウとそれに関連するOpenGLまたはOpenGL ESコンテキストを作成する。ウィンドウとそのコンテキストの作成方法を制御するオプションのほとんどは、ウィンドウヒントで指定されます。
作成に成功しても、現在のコンテキストは変更されない。新しく作成されたコンテキストを使用する前に、それを現在のコンテキストにする必要があります。shareパラメータについては、コンテキストオブジェクトの共有を参照してください。
すべてのパラメータとヒントがハード制約ではないため、作成されるウィンドウ、フレームバッファ、コンテキストは要求したものと異なる場合があります。これにはウィンドウのサイズ、特にフルスクリーンウィンドウのサイズも含まれます。作成されたウィンドウ、フレームバッファ、コンテキストの実際の属性を問い合わせるには、glfwGetWindowAttrib、glfwGetWindowSize、glfwGetFramebufferSizeを参照してください。
フルスクリーンウィンドウを作成するには、ウィンドウがカバーするモニタを指定する必要がある。モニターが指定されない場合、ウィンドウはウィンドウモードになります。ユーザーが特定のモニターを選択する方法がない限り、プライマリーモニターを選択することをお勧めします。接続されているモニターを問い合わせる方法については、モニターの取得を参照してください。
フルスクリーンウィンドウの場合、指定されたサイズはウィンドウの希望するビデオモードの解像度になります。フルスクリーンウィンドウがアイコン化されていない限り、希望するビデオモードに最も近いサポートされているビデオモードが指定されたモニターに設定されます。ウィンドウ付きフルスクリーンウィンドウやボーダーレスフルスクリーンウィンドウと呼ばれるウィンドウの作成を含む、フルスクリーンウィンドウに関する情報は、「ウィンドウ付きフルスクリーン」ウィンドウを参照してください。
ウィンドウを作成したら、glfwSetWindowMonitorでウィンドウモードとフルスクリーンモードを切り替えることができます。これはOpenGLやOpenGL ESのコンテキストには影響しません。
デフォルトでは、新しく作成されたウィンドウはウィンドウシステムが推奨する配置を使用します。特定の位置にウィンドウを作成するには、GLFW_VISIBLEウィンドウヒントを使用してウィンドウを最初は非表示にし、その位置を設定してから表示します。
少なくとも1つのフルスクリーンウィンドウがアイコン化されていない限り、スクリーンセーバーの起動は禁止される。
ウィンドウシステムはウィンドウサイズに制限を設けています。非常に大きいまたは非常に小さいウィンドウサイズは、作成時にウィンドウシステムによって上書きされる可能性があります。作成後に実際のサイズを確認してください。
スワップ間隔はウィンドウ作成中には設定されず、ドライバの設定やデフォルトによって初期値が異なる場合があります。
GLFWwindow * glfwCreateWindow(int width, int height, const char * title, GLFWmonitor * monitor, GLFWwindow * share)引数:
[in] width: ウィンドウの幅をスクリーン座標で指定する。これはゼロより大きくなければならない。[in] height: ウィンドウの高さをスクリーン座標で指定する。これはゼロより大きくなければならない。[in] title: UTF-8でエンコードされた最初のウィンドウタイトル。[in] monitor: フルスクリーンモードで使用するモニター、またはウィンドウモードで使用するNULL。[in] share: リソースを共有するコンテキストのウィンドウ、またはリソースを共有しない場合はNULL。
戻り値:
作成されたウィンドウのハンドル、またはエラーが発生した場合はNULL。
エラー:
起こりうるエラーは GLFW_NOT_INITIALIZED, GLFW_INVALID_ENUM, GLFW_INVALID_VALUE, GLFW_API_UNAVAILABLE, GLFW_VERSION_UNAVAILABLE, GLFW_FORMAT_UNAVAILABLE, GLFW_PLATFORM_ERROR です。
備考:
- Windows: Microsoft GDIソフトウェアOpenGL実装だけが利用可能な場合、ウィンドウの作成に失敗します。
- Windows: 実行ファイルにGLFW_ICONという名前のアイコンリソースがあれば、それがウィンドウの初期アイコンとして設定される。そのようなアイコンがない場合、IDI_APPLICATIONアイコンが代わりに使用されます。別のアイコンを設定するには、glfwSetWindowIconを参照してください。
- Windows: リソースを共有するコンテキストは、他のどのスレッドにも存在してはならない。
- macOS: OSはOpenGLバージョン3.2以降の前方互換性のあるコアプロファイルコンテキストのみをサポートしています。バージョン3.2以降のOpenGLコンテキストを作成する前に、それに応じてGLFW_OPENGL_FORWARD_COMPATとGLFW_OPENGL_PROFILEヒントを設定する必要があります。OpenGL 3.0と3.1のコンテキストはmacOSでは全くサポートされていません。
- macOS: GLFWウィンドウはドキュメントウィンドウではないのでアイコンはありませんが、ドックアイコンはアプリケーションバンドルのアイコンと同じになります。バンドルに関する情報は、Mac Developer Library の Bundle Programming Guide を参照してください。
- macOS: ウィンドウが最初に作られるとき、メニューバーが作られます。GLFWがMainMenu.nibを見つけた場合、それが読み込まれ、メニューバーが含まれていると仮定されます。そうでない場合は、Hide、Quit、Aboutのような一般的なコマンドを含む最小限のメニューバーが手動で作成されます。Aboutエントリは、アプリケーションのバンドルからの情報を含む最小限のaboutダイアログを開きます。メニューバーの作成はGLFW_COCOA_MENUBAR initヒントで完全に無効にすることができる。
- macOS: OS X 10.10以降では、GLFW_COCOA_RETINA_FRAMEBUFFERヒントがGLFW_TRUEで、アプリケーションバンドルのInfo.plistでNSHighResolutionCapableキーが有効になっていない限り、ウィンドウフレームはRetinaディスプレイ上でフル解像度でレンダリングされません。詳しくは、Mac Developer LibraryのHigh Resolution Guidelines for OS Xを参照してください。GLFWのテストプログラムとサンプルプログラムでは、このためにカスタムInfo.plistテンプレートを使用しています。このテンプレートはソースツリーのCMake/MacOSXBundleInfo.plist.inにあります。
- macOS: GLFW_COCOA_FRAME_NAMEでフレームの自動保存を有効にする場合、指定されたウィンドウサイズと位置は、以前に保存された値で上書きされることがあります。
- X11: ウィンドウ・マネージャーによっては、最初に隠されたウィンドウの配置を尊重しないものもあります。
- X11: X11の非同期的な性質により、ウィンドウが要求された状態に到達するまでに時間がかかることがあります。つまり、ウィンドウの作成後、最終的なサイズや位置、その他の属性を直接問い合わせることができない可能性があります。
- X11: WM_CLASSウィンドウプロパティのクラス部分は、デフォルトでこの関数に渡されたウィンドウタイトルに設定される。インスタンス部分は、環境変数RESOURCE_NAMEが存在し、空でなければ、その内容を使用するか、ウィンドウタイトルにフォールバックする。これを上書きするには、GLFW_X11_CLASS_NAME と GLFW_X11_INSTANCE_NAME ウィンドウヒントを設定する。
- Wayland: コンポジターはウィンドウを適切に装飾するために、GLFW 用の xdg-decoration プロトコルを実装する必要があります。このプロトコルがサポートされていない場合、またはコンポジターがクライアントサイドの装飾を好む場合は、wp_viewporter プロトコルを使用して非常にシンプルなフォールバックフレームが描画されます。コンポジターは、例えばキーバインドメカニズムを使用して、クローズ、最大化、フルスクリーンイベントを発行することができます。これらのプロトコルがサポートされていない場合、ウィンドウは装飾されません。
- Wayland: フルスクリーンウィンドウは、要求されたサイズやリフレッシュレートに関係なく、モードを変更しようとしません。
- Wayland: スクリーンセーバーの禁止には、アイドル・インヒビット・プロトコルがユーザーのコンポジターに実装されている必要がある。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Window creation
- glfwDestroyWindow
追加:
バージョン 3.0 で追加されました。glfwOpenWindow を置き換える。
glfwDestroyWindow()
この関数は、指定されたウィンドウとそのコンテキストを破棄する。この関数を呼び出すと、そのウィンドウに対してそれ以降のコールバックは呼び出されません。
指定されたウィンドウのコンテキストがメインスレッドにある場合は、破棄される前に切り離されます。
void glfwDestroyWindow(GLFWwindow * window)引数:
[in] window: 破棄するウィンドウ。
エラー:
起こりうるエラーはGLFW_NOT_INITIALIZEDとGLFW_PLATFORM_ERRORである。
注釈:
この関数が呼び出されたとき、指定されたウィンドウのコンテキストは、他のスレッド上でカレントであってはならない。
リエントランシー:
この関数はコールバックから呼んではならない。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Window creation
- glfwCreateWindow
追加:
バージョン3.0で追加。glfwCloseWindow を置き換える。
glfwWindowShouldClose()
この関数は、指定されたウィンドウのクローズフラグの値を返す。
int glfwWindowShouldClose(GLFWwindow * window)引数:
[in] window: クエリーするウィンドウ。
戻り値:
クローズフラグの値。
エラー:
考えられるエラーはGLFW_NOT_INITIALIZED。
スレッドセーフ:
この関数はどのスレッドからでも呼び出すことができる。アクセスは同期化されない。
参照:
- Window closing and close flag
追加:
バージョン3.0で追加。
glfwSetWindowShouldClose()
この関数は、指定されたウィンドウのクローズフラグの値を設定する。これは、ユーザがウィンドウを閉じようとするのを上書きしたり、ウィンドウを閉じるように合図したりするために使用できます。
void glfwSetWindowShouldClose(GLFWwindow * window, int value)引数:
[in] window: フラグを変更するウィンドウ。[in] value: 新しい値。
エラー:
考えられるエラーはGLFW_NOT_INITIALIZED。
スレッドセーフ:
この関数はどのスレッドからでも呼び出すことができる。アクセスは同期化されない。
参照:
- Window closing and close flag
追加:
バージョン3.0で追加。
glfwSetWindowTitle()
この関数は、指定されたウィンドウのタイトルを UTF-8 でエンコードして設定する。
void glfwSetWindowTitle(GLFWwindow * window, const char * title)引数:
[in] window: タイトルを変更するウィンドウ。[in] title: UTF-8でエンコードされたウィンドウのタイトル。
エラー:
起こりうるエラーはGLFW_NOT_INITIALIZEDとGLFW_PLATFORM_ERRORである。
備考:
macOS: ウィンドウのタイトルは、次にイベントを処理するまで更新されない。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Window title
追加:
バージョン1.0で追加。GLFW 3: ウィンドウハンドルパラメーターを追加。
glfwSetWindowIcon()
この関数は、指定されたウィンドウのアイコンを設定する。候補画像の配列が渡された場合、システムが希望するサイズのもの、 あるいはそれに最も近いものが選択されます。画像が指定されない場合、ウィンドウはデフォルトのアイコンに戻ります。
ピクセルは32ビット、リトルエンディアン、非前乗算RGBA、つまり各チャンネル8ビットで、赤チャンネルが先。 これらは、左上から順番に詰め込まれた列として正規に並べられている。
希望する画像サイズは、プラットフォームやシステム設定によって異なります。選択された画像は必要に応じて拡大縮小されます。最適なサイズは16x16、32x32、48x48です。
void glfwSetWindowIcon(GLFWwindow * window, int count, const GLFWimage * images)引数:
[in] window: アイコンを設定するウィンドウ。[in] count: 指定した配列に含まれる画像の数。デフォルトのウィンドウアイコンに戻す場合は 0。[in] images: アイコンを作成する画像。countが0の場合は無視される。
エラー:
起こりうるエラーはGLFW_NOT_INITIALIZED、GLFW_INVALID_VALUE、GLFW_PLATFORM_ERRORである。
ポインタの寿命:
指定された画像データは、この関数が戻る前にコピーされる。
備考:
- macOS: GLFWウィンドウはドキュメントウィンドウではないのでアイコンがなく、この関数は何もしません。ドックアイコンはアプリケーションバンドルのアイコンと同じになります。バンドルに関する情報は、Mac Developer Library の Bundle Programming Guide を参照してください。
- Wayland: アイコンを変更する既存のプロトコルはないので、ウィンドウはアプリケーションのデスクトップファイルで定義されたものを継承します。この関数は常にGLFW_PLATFORM_ERRORを返します。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Window icon
追加:
バージョン3.2で追加。
glfwGetWindowPos()
この関数は、指定されたウィンドウのコンテンツ領域の左上隅の位置をスクリーン座標で取得する。
position 引数のいずれかまたはすべては NULL であってもよい。エラーが発生した場合、NULL 以外の位置引数はすべて 0 に設定されます。
void glfwGetWindowPos(GLFWwindow * window, int * xpos, int * ypos)引数:
[in] window: クエリーするウィンドウ。[out] xpos: コンテンツ領域の左上隅のx座標を格納する場所、またはNULL。[out] ypos: コンテンツ領域の左上隅のy座標を格納する場所、またはNULL。
エラー:
起こりうるエラーはGLFW_NOT_INITIALIZEDとGLFW_PLATFORM_ERRORである。
備考:
- Wayland: アプリケーションがウィンドウのグローバルポジションを取得する方法はありません。この関数は常にGLFW_PLATFORM_ERRORを出します。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Window position
- glfwSetWindowPos
追加:
バージョン3.0で追加。
glfwSetWindowPos()
この関数は、指定されたウィンドウモードのウィンドウのコンテント領域の左上隅の位置をスクリーン座標で設定する。ウィンドウがフルスクリーンウィンドウの場合、この関数は何もしません。
ユーザを混乱させたり困らせたりするので、よほどの理由がない限り、すでに表示されているウィンドウを移動するためにこの関数を使用しないでください。
ウィンドウマネージャは許可される位置に制限を加えるかもしれません。GLFWはこれらの制限を上書きすることはできませんし、またそうすべきではありません。
void glfwSetWindowPos(GLFWwindow * window, int xpos, int ypos)引数:
[in] window: クエリーするウィンドウ。[in] xpos: コンテンツ領域の左上隅のx座標。[in] ypos: コンテンツ領域の左上隅のy座標。
エラー:
起こりうるエラーはGLFW_NOT_INITIALIZEDとGLFW_PLATFORM_ERRORである。
備考:
- Wayland: この関数は常にGLFW_PLATFORM_ERRORを出します。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Window position
- glfwGetWindowPos
追加:
バージョン1.0で追加。GLFW 3: ウィンドウハンドルパラメーターを追加。
glfwGetWindowSize()
この関数は、指定されたウィンドウのコンテンツ領域のサイズをスクリーン座標で取得する。ウィンドウのフレームバッファのサイズをピクセル単位で取得したい場合は、 glfwGetFramebufferSizeを参照してください。
size引数のいずれか、またはすべてがNULLであってもよい。エラーが発生した場合、NULLでないsize引数はすべて0に設定される。
void glfwGetWindowSize(GLFWwindow * window, int * width, int * height)引数:
[in] window: 取得するウィンドウのサイズ。[out] width: コンテンツ領域の幅をスクリーン座標で格納する場所、またはNULL。[out] height: コンテンツ領域の高さをスクリーン座標で格納する場所、またはNULL。
エラー:
起こりうるエラーはGLFW_NOT_INITIALIZEDとGLFW_PLATFORM_ERRORである。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Window size
- glfwSetWindowSize
追加:
バージョン1.0で追加。GLFW 3: ウィンドウハンドルパラメーターを追加。
glfwSetWindowSizeLimits()
この関数は、指定されたウィンドウのコンテンツ領域のサイズ制限を設定する。ウィンドウがフルスクリーンの場合、サイズ制限はウィンドウ化されて初めて有効になる。ウィンドウがリサイズ可能でない場合、この関数は何もしません。
サイズ制限は、ウィンドウモードのウィンドウに即座に適用され、リサイズされる可能性があります。
最大寸法は最小寸法以上でなければならず、すべて0以上でなければならない。
void glfwSetWindowSizeLimits(GLFWwindow * window, int minwidth, int minheight, int maxwidth, int maxheight)引数:
[in] window: 制限を設定するウィンドウ。[in] minwidth: コンテンツ領域の最小幅（スクリーン座標）、またはGLFW_DONT_CARE。[in] minheight: コンテンツ領域の最小の高さ（スクリーン座標）、またはGLFW_DONT_CARE。[in] maxwidth: コンテンツ領域のスクリーン座標での最大幅、またはGLFW_DONT_CARE。[in] maxheight: コンテンツ領域のスクリーン座標での最大の高さ、またはGLFW_DONT_CARE。
エラー:
起こりうるエラーはGLFW_NOT_INITIALIZED、GLFW_INVALID_VALUE、GLFW_PLATFORM_ERRORである。
備考:
サイズ制限とアスペクト比が競合するように設定した場合、結果は不定です。
- Wayland: サイズ制限は、ユーザーまたはコンポジターによって実際にウィンドウのサイズが変更されるまで適用されません。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Window size limits
- glfwSetWindowAspectRatio
追加:
バージョン3.2で追加。
glfwSetWindowAspectRatio()
この関数は、指定されたウィンドウのコンテンツ領域に必要なアスペクト比を設定する。ウィンドウがフルスクリーンの場合、アスペクト比はウィンドウ化されて初めて有効になる。ウィンドウがリサイズ可能でない場合、この関数は何もしません。
アスペクト比は分子と分母で指定し、両方の値が0より大きくなければならない。例えば、一般的な16:9のアスペクト比は、それぞれ16と9と指定します。
分子と分母を GLFW_DONT_CARE に設定すると、アスペクト比の制限は無効になる。
アスペクト比はウィンドウモードのウィンドウに即座に適用され、リサイズされることがある。
void glfwSetWindowAspectRatio(GLFWwindow * window, int numer, int denom)引数:
[in] window: 制限を設定するウィンドウ。[in] numer: 希望するアスペクト比の分子、またはGLFW_DONT_CARE。[in] denom: 希望するアスペクト比の分母、またはGLFW_DONT_CARE。
エラー:
起こりうるエラーはGLFW_NOT_INITIALIZED、GLFW_INVALID_VALUE、GLFW_PLATFORM_ERRORである。
備考:
サイズ制限とアスペクト比が競合するように設定した場合、結果は不定です。
- Wayland: アスペクト比は、ユーザーまたはコンポジターによってウィンドウのサイズが実際に変更されるまで適用されません。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Window size limits
- glfwSetWindowSizeLimits
追加:
バージョン3.2で追加。
glfwSetWindowSize()
この関数は、指定されたウィンドウのコンテンツ領域のサイズをスクリーン座標で設定する。
フルスクリーンウィンドウの場合、この関数は希望するビデオモードの解像度を更新し、ウィンドウのコンテキストに影響を与えることなく、最も近いビデオモードに切り替えます。コンテキストに影響がないため、フレームバッファのビット深度は変更されません。
解像度だけでなく、希望するビデオモードのリフレッシュレートも更新したい場合は、glfwSetWindowMonitorを参照してください。
ウィンドウマネージャは許可されるサイズに制限を加えるかもしれません。GLFWはこれらの制限を上書きすることはできませんし、また、上書きすべきではありません。
void glfwSetWindowSize(GLFWwindow * window, int width, int height)引数:
[in] window: リサイズするウィンドウ。[in] width: ウィンドウの内容領域の幅をスクリーン座標で指定する。[in] height: ウィンドウの内容領域の高さをスクリーン座標で指定する。
エラー:
起こりうるエラーはGLFW_NOT_INITIALIZEDとGLFW_PLATFORM_ERRORである。
備考:
- Wayland: フルスクリーンウィンドウは、要求されたサイズに関係なく、モードを変更しようとしない。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Window size
- glfwGetWindowSize
- glfwSetWindowMonitor
追加:
バージョン1.0で追加。GLFW 3: ウィンドウハンドルパラメーターを追加。
glfwGetFramebufferSize()
この関数は、指定されたウィンドウのフレームバッファのサイズをピクセル単位で取得する。ウィンドウのサイズをスクリーン座標で取得したい場合は、 glfwGetWindowSizeを参照してください。
size引数のいずれか、またはすべてがNULLであってもよい。エラーが発生した場合、NULLでないsize引数はすべて0に設定されます。
void glfwGetFramebufferSize(GLFWwindow * window, int * width, int * height)引数:
[in] window: フレームバッファを問い合わせるウィンドウ。[out] width: フレームバッファの幅をピクセル単位で格納する場所、またはNULL。[out] height: フレームバッファの高さをピクセル単位で格納する場所、またはNULL。
エラー:
起こりうるエラーはGLFW_NOT_INITIALIZEDとGLFW_PLATFORM_ERRORである。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Framebuffer size
- glfwSetFramebufferSizeCallback
追加:
バージョン3.0で追加。
glfwGetWindowFrameSize()
この関数は、指定されたウィンドウのフレームの各辺のサイズをスクリーン座標で取得する。このサイズには、ウィンドウにタイトルバーがある場合はタイトルバーも含まれる。フレームのサイズは、それを作成するために使用されるウィンドウ関連のヒントによって異なる場合があります。
この関数は、特定の座標軸に沿ったオフセットではなく、各ウィンドウ枠の辺のサイズを取得するため、取得される値は常にゼロまたは正の値になります。
size引数のいずれか、またはすべてがNULLであってもよい。エラーが発生した場合、NULLでないsize引数はすべて0に設定されます。
void glfwGetWindowFrameSize(GLFWwindow * window, int * left, int * top, int * right, int * bottom)引数:
[in] window: フレームサイズを問い合わせるウィンドウ。[out] left: ウィンドウ枠の左端のサイズをスクリーン座標で格納する場所、またはNULL。[out] top: ウィンドウ枠の上端のサイズをスクリーン座標で格納する場所、またはNULL。[out] right: ウィンドウ枠の右端のサイズをスクリーン座標で格納する場所、またはNULL。[out] bottom: ウィンドウ枠の下端のサイズをスクリーン座標で格納する場所、またはNULL。
エラー:
起こりうるエラーはGLFW_NOT_INITIALIZEDとGLFW_PLATFORM_ERRORである。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Window size
追加:
バージョン3.1で追加。
glfwGetWindowContentScale()
この関数は、指定されたウィンドウのコンテンツスケールを取得します。コンテンツスケールは、現在のDPIとプラットフォームのデフォルトDPIの比率です。これはテキストやUI要素にとって特に重要です。これによってスケーリングされたUIのピクセル寸法があなたのマシンで適切に見えるなら、他のマシンではDPIやスケーリング設定に関係なく、妥当なサイズで表示されるはずです。これは、システムのDPIとスケーリング設定がある程度正しいことに依存します。
各モニターが独自のコンテンツ・スケールを持つことができるシステムでは、ウィンドウのコンテンツ・スケールは、システムがウィンドウをどのモニター上にあるとみなすかに依存します。
void glfwGetWindowContentScale(GLFWwindow * window, float * xscale, float * yscale)引数:
[in] window: クエリーするウィンドウ。[out] xscale: X軸の内容スケールを格納する場所、または NULL。[out] yscale: Y軸の内容スケールを格納する場所、または NULL。
エラー:
起こりうるエラーはGLFW_NOT_INITIALIZEDとGLFW_PLATFORM_ERRORである。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Window content scale
- glfwSetWindowContentScaleCallback
- glfwGetMonitorContentScale
追加:
バージョン3.3で追加。
glfwGetWindowOpacity()
この関数は、装飾を含むウィンドウの不透明度を返します。
不透明度 (またはアルファ値) は 0 から 1 までの正の整数で、 0 は完全に透明、 1 は完全に不透明です。システムがウィンドウ全体の透過をサポートしていない場合、この関数は常に1を返します。
新しく作成されたウィンドウの不透明度の初期値は1です。
float glfwGetWindowOpacity(GLFWwindow * window)引数:
[in] window: クエリーするウィンドウ。
戻り値:
指定したウィンドウの不透明度。
エラー:
起こりうるエラーはGLFW_NOT_INITIALIZEDとGLFW_PLATFORM_ERRORである。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Window transparency
- glfwSetWindowOpacity
追加:
バージョン3.3で追加。
glfwSetWindowOpacity()
この関数は、装飾を含むウィンドウの不透明度を設定する。
不透明度 (またはアルファ値) は 0 から 1 までの正の整数で、0 は完全に透明、1 は完全に不透明です。
新しく作成されたウィンドウの初期値は 1 です。
フレームバッファの透明度を使用して作成されたウィンドウは、ウィンドウ全体の透明度を使用することはできません。この場合の結果は未定義です。
void glfwSetWindowOpacity(GLFWwindow * window, float opacity)引数:
[in] window: 不透明度を設定するウィンドウ。[in] opacity: 指定されたウィンドウの希望の不透明度。
エラー:
起こりうるエラーはGLFW_NOT_INITIALIZEDとGLFW_PLATFORM_ERRORである。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Window transparency
- glfwGetWindowOpacity
追加:
バージョン3.3で追加。
glfwIconifyWindow()
この関数は、指定されたウィンドウが以前に復元されていた場合、そのウィンドウをアイコン化（最小化）する。ウィンドウが既にアイコン化されている場合、この関数は何もしない。
指定されたウィンドウがフルスクリーンウィンドウの場合、 GLFWはモニタの元のビデオモードを復元する。ウィンドウが復元されると、ウィンドウの希望するビデオモードが再び設定される。
void glfwIconifyWindow(GLFWwindow * window)引数:
[in] window: アイコン化するウィンドウ。
エラー:
起こりうるエラーはGLFW_NOT_INITIALIZEDとGLFW_PLATFORM_ERRORである。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Window iconification
- glfwRestoreWindow
- glfwMaximizeWindow
追加:
バージョン2.1で追加。GLFW 3: ウィンドウハンドルパラメーターを追加。
glfwRestoreWindow()
この関数は、指定されたウィンドウが以前にアイコン化（最小化）または最大化されていた場合に、そのウィンドウを復元する。ウィンドウが既に復元されている場合、この関数は何もしません。
指定されたウィンドウがアイコン化されたフルスクリーンウィンドウである場合、 ウィンドウが復元されるときに、そのモニタに対して希望するビデオモードが再び設定される。
void glfwRestoreWindow(GLFWwindow * window)引数:
[in] window: 復元するウィンドウ。
エラー:
起こりうるエラーはGLFW_NOT_INITIALIZEDとGLFW_PLATFORM_ERRORである。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Window iconification
- glfwIconifyWindow
- glfwMaximizeWindow
追加:
バージョン2.1で追加。GLFW 3: ウィンドウハンドルパラメーターを追加。
glfwMaximizeWindow()
この関数は、指定されたウィンドウが以前に最大化されていなかった場合に、そのウィンドウを最大化する。ウィンドウが既に最大化されている場合、この関数は何もしない。
指定されたウィンドウがフルスクリーンウィンドウの場合、この関数は何もしない。
void glfwMaximizeWindow(GLFWwindow * window)引数:
[in] window: 最大化するウィンドウ。
エラー:
起こりうるエラーはGLFW_NOT_INITIALIZEDとGLFW_PLATFORM_ERRORである。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出すことができる。
参照:
- Window iconification
- glfwIconifyWindow
- glfwRestoreWindow
追加:
GLFW 3.2で追加。
glfwShowWindow()
この関数は、指定されたウィンドウが以前に非表示であった場合に、そのウィンドウを表示するようにする。ウィンドウがすでに表示されているか、フルスクリーンモードになっている場合、この関数は何もしません。
デフォルトでは、ウィンドウモードのウィンドウは表示されているときにフォーカスされます。 新規に作成されたすべてのウィンドウのこの動作を変更するには、GLFW_FOCUS_ON_SHOW ウィンドウヒントを設定するか、既存のウィンドウの動作を glfwSetWindowAttrib で変更します。
void glfwShowWindow(GLFWwindow * window)引数:
[in] window: 可視化するウィンドウ。
エラー:
起こりうるエラーはGLFW_NOT_INITIALIZEDとGLFW_PLATFORM_ERRORである。
備考:
- Wayland: Waylandはデスクトップの各フレームが完全であることを望んでいるため、この関数はウィンドウをすぐには表示しない。その代わり、この呼び出しの次にウィンドウのフレームバッファが更新されたときに見えるようになります。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Window visibility
- glfwHideWindow
追加:
バージョン3.0で追加。
glfwHideWindow()
この関数は、指定されたウィンドウが以前に表示されていた場合、そのウィンドウを非表示にする。ウィンドウがすでに非表示になっているか、フルスクリーンモードになっている場合、この関数は何もしません。
void glfwHideWindow(GLFWwindow * window)引数:
[in] window: 非表示にするウィンドウ。
エラー:
起こりうるエラーはGLFW_NOT_INITIALIZEDとGLFW_PLATFORM_ERRORである。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Window visibility
- glfwShowWindow
追加:
バージョン3.0で追加。
glfwFocusWindow()
この関数は、指定されたウィンドウを前面に出し、入力フォーカスを設定する。ウィンドウはすでに表示されていて、アイコン化されていない必要があります。
デフォルトでは、ウィンドウモードとフルスクリーンモードの両方のウィンドウは、最初に作成されたときにフォーカスされます。この動作を無効にするにはGLFW_FOCUSEDを設定します。
また、デフォルトでは、ウィンドウモードのウィンドウは glfwShowWindow で表示されたときにフォーカスされる。この動作を無効にするには、GLFW_FOCUS_ON_SHOWを設定する。
この関数を使って他のアプリケーションからフォーカスを奪わないでください。フォーカスを奪うことは非常に邪魔になります。
ユーザーの注意を引くためのあまり破壊的でない方法については、注意要求を参照してください。
void glfwFocusWindow(GLFWwindow * window)引数:
[in] window: 入力フォーカスを与えるウィンドウ。
エラー:
起こりうるエラーはGLFW_NOT_INITIALIZEDとGLFW_PLATFORM_ERRORである。
備考:
- Wayland: アプリケーションがウィンドウを前面に出すことはできない。この関数は常にGLFW_PLATFORM_ERRORを出します。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Window input focus
- Window attention request
追加:
バージョン3.2で追加。
glfwRequestWindowAttention()
この関数は、指定されたウィンドウに対するユーザーの注意を要求する。これがサポートされていないプラットフォームでは、アプリケーション全体へのアテンションが要求される。
通常、ウィンドウまたはアプリケーションにフォーカスを当てることによって、ユーザーが注意を与えたら、システムは自動的に要求を終了します。
void glfwRequestWindowAttention(GLFWwindow * window)引数:
[in] window: 注意を要求するウィンドウ。
エラー:
起こりうるエラーはGLFW_NOT_INITIALIZEDとGLFW_PLATFORM_ERRORである。
備考:
- macOS: 特定のウィンドウではなく、アプリケーション全体に注意を払うことが求められる。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Window attention request
追加:
バージョン3.3で追加。
glfwGetWindowMonitor()
この関数は、指定されたウィンドウが全画面表示されているモニタのハンドルを返します。
GLFWmonitor * glfwGetWindowMonitor(GLFWwindow * window)引数:
[in] window: クエリーするウィンドウ。
戻り値:
ウィンドウがウィンドウモードの場合、またはエラーが発生した場合はNULL。
エラー:
考えられるエラーはGLFW_NOT_INITIALIZED。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Window monitor
- glfwSetWindowMonitor
追加:
バージョン3.0で追加。
glfwSetWindowMonitor()
この関数は、ウィンドウがフルスクリーンモードで使用するモニタを設定するか、モニタがNULLの場合はウィンドウモードにする。
モニタを設定するとき、この関数は希望するビデオモードの幅、高さ、リフレッシュレートを更新し、それに最も近いビデオモードに切り替えます。モニターを設定する場合、ウィンドウの位置は無視される。
モニタがNULLの場合、位置、幅、高さはウィンドウのコンテンツ領域を配置するために使用される。モニターが指定されていない場合、リフレッシュレートは無視される。
フルスクリーンウィンドウの解像度またはウィンドウモードウィンドウのサイズのみを更新したい場合は、 glfwSetWindowSizeを参照してください。
ウィンドウがフルスクリーンからウィンドウモードに遷移するとき、この関数は、装飾、フローティング、サイズ変更可能、サイズやアスペクト比の制限など、以前のウィンドウ設定を復元します。
void glfwSetWindowMonitor(GLFWwindow * window, GLFWmonitor * monitor, int xpos, int ypos, int width, int height, int refreshRate)引数:
[in] window: モニター、サイズ、ビデオモードを設定するウィンドウ。[in] monitor: 希望するモニター、またはウィンドウモードに設定する場合は NULL。[in] xpos: コンテンツ領域の左上隅のX座標。[in] ypos: コンテンツ領域の左上隅のy座標。[in] width: コンテンツエリアまたはビデオモードの、スクリーン座標での希望の位置。[in] height: コンテンツエリアまたはビデオモードの高さを、スクリーン座標で指定する。[in] refreshRate: ビデオモードの希望リフレッシュレート（Hz）、またはGLFW_DONT_CARE。
エラー:
起こりうるエラーはGLFW_NOT_INITIALIZEDとGLFW_PLATFORM_ERRORである。
備考:
OpenGLやOpenGL ESのコンテキストが破壊されたり、サイズ変更やモード切り替えの影響を受けたりすることはありませんが、フレームバッファのサイズが変更された場合は、ビューポートを更新する必要があるかもしれません。
- Wayland: アプリケーションがこのプロパティを設定する方法がないため、希望のウィンドウ位置は無視される。
- Wayland: ウィンドウをフルスクリーンに設定すると、要求されたサイズやリフレッシュ・レートに関係なく、モードを変更しようとしません。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Window monitor
- Full screen windows
- glfwGetWindowMonitor
- glfwSetWindowSize
追加:
バージョン3.2で追加。
glfwGetWindowAttrib()
この関数は、指定されたウィンドウまたはそのOpenGLまたはOpenGL ESコンテキストの属性の値を返します。
int glfwGetWindowAttrib(GLFWwindow * window, int attrib)引数:
[in] window: クエリーするウィンドウ。[in] attrib: 値を返すウィンドウ属性。
戻り値:
属性の値。エラーが発生した場合はゼロ。
エラー:
起こりうるエラーはGLFW_NOT_INITIALIZED、GLFW_INVALID_ENUM、GLFW_PLATFORM_ERRORである。
備考:
フレームバッファ関連のヒントはウィンドウ属性ではありません。詳しくはフレームバッファ関連属性を参照してください。
ゼロはウィンドウやコンテキストに関連する多くの属性で有効な値なので、ゼロの戻り値をエラーの兆候として使うことはできない。しかし、有効な引数が渡され、ライブラリが初期化されている限り、この関数が失敗することはありません。
- Wayland: そのためGLFW_ICONIFIEDは常にGLFW_FALSEを返します。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Window attributes
- glfwSetWindowAttrib
追加:
バージョン3.0で追加されました。glfwGetWindowParamとglfwGetGLVersionを置き換える。
glfwSetWindowAttrib()
この関数は、指定されたウィンドウの属性値を設定します。
サポートされている属性は GLFW_DECORATED, GLFW_RESIZABLE, GLFW_FLOATING, GLFW_AUTO_ICONIFY, GLFW_FOCUS_ON_SHOW です。
これらの属性のいくつかはフルスクリーンウィンドウでは無視されます。新しい値は、ウィンドウが後でウィンドウ化された場合に有効になります。
これらの属性のいくつかはウィンドウ・モードのウィンドウでは無視される。新しい値は、後にウィンドウがフルスクリーンになった場合に有効になります。
void glfwSetWindowAttrib(GLFWwindow * window, int attrib, int value)引数:
[in] window: 属性を設定するウィンドウ。[in] attrib: サポートされているウィンドウ属性。[in] value: GLFW_TRUEまたはGLFW_FALSE。
エラー:
起こりうるエラーはGLFW_NOT_INITIALIZED、GLFW_INVALID_ENUM、GLFW_INVALID_VALUE、GLFW_PLATFORM_ERRORである。
備考:
glfwGetWindowAttribを呼び出すと、たとえその値がウィンドウの現在のモードで無視されたとしても、常に最新の値が返される。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Window attributes
- glfwGetWindowAttrib
追加:
バージョン3.3で追加。
glfwSetWindowUserPointer()
この関数は、指定されたウィンドウのユーザー定義ポインターを設定する。現在の値はウィンドウが破棄されるまで保持される。初期値は NULL です。
void glfwSetWindowUserPointer(GLFWwindow * window, void * pointer)引数:
[in] window: ポインタを設定するウィンドウ。[in] pointer: 新しい値。
エラー:
考えられるエラーはGLFW_NOT_INITIALIZED。
スレッドセーフ:
この関数はどのスレッドからでも呼び出すことができる。アクセスは同期化されない。
参照:
- User pointer
- glfwGetWindowUserPointer
追加:
バージョン3.0で追加。
glfwGetWindowUserPointer()
この関数は、指定されたウィンドウのユーザー定義ポインタの現在値を返す。初期値は NULL です。
void * glfwGetWindowUserPointer(GLFWwindow * window)引数:
[in] window: ポインタを返すウィンドウ。
エラー:
考えられるエラーはGLFW_NOT_INITIALIZED。
スレッドセーフ:
この関数はどのスレッドからでも呼び出すことができる。アクセスは同期化されない。
参照:
- User pointer
- glfwSetWindowUserPointer
追加:
バージョン3.0で追加。
glfwSetWindowPosCallback()
この関数は、指定されたウィンドウの位置コールバックを設定する。このコールバックには、ウィンドウのコンテント領域の左上隅の位置をスクリーン座標で指定します。
GLFWwindowposfun glfwSetWindowPosCallback(GLFWwindow * window, GLFWwindowposfun callback)引数:
[in] window: コールバックを設定するウィンドウ。[in] callback: 新しいコールバック、または現在設定されているコールバックを削除する場合は NULL。
戻り値:
コールバックが設定されていないか、ライブラリが初期化されていない場合はNULL。
コールバックのシグネチャ:
void function_name(GLFWwindow* window, int xpos, int ypos)コールバック・パラメータについては、関数ポインタ型を参照のこと。
エラー:
考えられるエラーはGLFW_NOT_INITIALIZED。
備考:
- Wayland: アプリケーションがグローバルポジションを知る方法がないため、このコールバックが呼ばれることはない。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Window position
追加:
バージョン3.0で追加。
glfwSetWindowSizeCallback()
この関数は、指定されたウィンドウのサイズ変更時に呼び出されるサイズコールバックを設定します。コールバックには、ウィンドウのコンテンツ領域のサイズがスクリーン座標で指定されます。
GLFWwindowsizefun glfwSetWindowSizeCallback(GLFWwindow * window, GLFWwindowsizefun callback)引数:
[in] window: コールバックを設定するウィンドウ。[in] callback: 新しいコールバック、または現在設定されているコールバックを削除する場合は NULL。
戻り値:
コールバックが設定されていないか、ライブラリが初期化されていない場合はNULL。
コールバックのシグネチャ:
void function_name(GLFWwindow* window, int width, int height)コールバック・パラメータについては、関数ポインタ型を参照のこと。
エラー:
考えられるエラーはGLFW_NOT_INITIALIZED。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Window size
追加:
バージョン1.0で追加。GLFW 3: ウィンドウハンドルパラメータと戻り値を追加。
glfwSetWindowCloseCallback()
この関数は、指定されたウィンドウのクローズ・コールバックを設定します。このコールバックは、ユーザーがタイトルバーのクローズ・ウィジェットをクリックするなどしてウィンドウを閉じようとしたときに呼び出されます。
クローズフラグはこのコールバックが呼ばれる前に設定されますが、glfwSetWindowShouldCloseでいつでも変更できます。
閉じるコールバックは glfwDestroyWindow によってトリガされません。
GLFWwindowclosefun glfwSetWindowCloseCallback(GLFWwindow * window, GLFWwindowclosefun callback)引数:
[in] window: コールバックを設定するウィンドウ。[in] callback: 新しいコールバック、または現在設定されているコールバックを削除する場合は NULL。
戻り値:
コールバックが設定されていないか、ライブラリが初期化されていない場合はNULL。
コールバックのシグネチャ:
void function_name(GLFWwindow* window)コールバック・パラメータについては、関数ポインタ型を参照のこと。
エラー:
考えられるエラーはGLFW_NOT_INITIALIZED。
備考:
- macOS: アプリケーションメニューから終了を選択すると、すべてのウィンドウの終了コールバックがトリガーされます。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Window closing and close flag
追加:
バージョン2.5で追加。GLFW 3: ウィンドウハンドルパラメータと戻り値を追加。
glfwSetWindowRefreshCallback()
この関数は、指定されたウィンドウのリフレッシュコールバックを設定します。このコールバックは、ウィンドウのコンテンツ領域を再描画する必要があるときに呼び出されます。
Aero、Compiz、Aqua、Waylandのような、ウィンドウの内容がオフスクリーンで保存されるコンポジット・ウィンドウ・システムでは、このコールバックは非常にまれにしか呼び出されないか、まったく呼び出されないかもしれません。
GLFWwindowrefreshfun glfwSetWindowRefreshCallback(GLFWwindow * window, GLFWwindowrefreshfun callback)引数:
[in] window: コールバックを設定するウィンドウ。[in] callback: 新しいコールバック、または現在設定されているコールバックを削除する場合は NULL。
戻り値:
コールバックが設定されていないか、ライブラリが初期化されていない場合はNULL。
コールバックのシグネチャ:
void function_name(GLFWwindow* window);コールバック・パラメータについては、関数ポインタ型を参照のこと。
エラー:
考えられるエラーはGLFW_NOT_INITIALIZED。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Window damage and refresh
追加:
バージョン2.5で追加。GLFW 3: ウィンドウハンドルパラメータと戻り値を追加。
glfwSetWindowFocusCallback()
この関数は、指定されたウィンドウのフォーカスコールバックを設定します。このコールバックは、ウィンドウが入力フォーカスを得たり失ったりしたときに呼び出されます。
入力フォーカスを失ったウィンドウのフォーカスコールバックが呼ばれた後、押されていたすべての合成キーとマウスボタンのリリースイベントが生成されます。詳しくは、glfwSetKeyCallback と glfwSetMouseButtonCallback を参照してください。
GLFWwindowfocusfun glfwSetWindowFocusCallback(GLFWwindow * window, GLFWwindowfocusfun callback)引数:
[in] window: コールバックを設定するウィンドウ。[in] callback: 新しいコールバック、または現在設定されているコールバックを削除する場合は NULL。
戻り値:
コールバックが設定されていないか、ライブラリが初期化されていない場合はNULL。
コールバックのシグネチャ:
void function_name(GLFWwindow* window, int focused)コールバック・パラメータについては、関数ポインタ型を参照のこと。
エラー:
考えられるエラーはGLFW_NOT_INITIALIZED。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Window input focus
追加:
バージョン3.0で追加。
glfwSetWindowIconifyCallback()
この関数は、指定されたウィンドウのアイコン化コールバックを設定します。このコールバックは、ウィンドウがアイコン化されたときや復元されたときに呼び出されます。
GLFWwindowiconifyfun glfwSetWindowIconifyCallback(GLFWwindow * window, GLFWwindowiconifyfun callback)引数:
[in] window: コールバックを設定するウィンドウ。[in] callback: 新しいコールバック、または現在設定されているコールバックを削除する場合は NULL。
戻り値:
コールバックが設定されていないか、ライブラリが初期化されていない場合はNULL。
コールバックのシグネチャ:
void function_name(GLFWwindow* window, int iconified)コールバック・パラメータについては、関数ポインタ型を参照のこと。
エラー:
考えられるエラーはGLFW_NOT_INITIALIZED。
備考:
- Wayland: XDG-shell プロトコルにはアイコン化のイベントがないため、このコールバックが呼び出されることはありません。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Window iconification
追加:
バージョン3.0で追加。
glfwSetWindowMaximizeCallback()
この関数は、指定されたウィンドウの最大化コールバックを設定します。このコールバックは、ウィンドウが最大化または復元されたときに呼び出されます。
GLFWwindowmaximizefun glfwSetWindowMaximizeCallback(GLFWwindow * window, GLFWwindowmaximizefun callback)引数:
[in] window: コールバックを設定するウィンドウ。[in] callback: 新しいコールバック、または現在設定されているコールバックを削除する場合は NULL。
戻り値:
コールバックが設定されていないか、ライブラリが初期化されていない場合はNULL。
コールバックのシグネチャ:
void function_name(GLFWwindow* window, int maximized)コールバック・パラメータについては、関数ポインタ型を参照のこと。
エラー:
考えられるエラーはGLFW_NOT_INITIALIZED。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Window maximization
追加:
バージョン3.3で追加。
glfwSetFramebufferSizeCallback()
この関数は、指定されたウィンドウのフレームバッファがサイズ変更されたときに呼び出される、指定されたウィンドウのフレームバッファリサイズコールバックを設定します。
GLFWframebuffersizefun glfwSetFramebufferSizeCallback(GLFWwindow * window, GLFWframebuffersizefun callback)引数:
[in] window: コールバックを設定するウィンドウ。[in] callback: 新しいコールバック、または現在設定されているコールバックを削除する場合は NULL。
戻り値:
コールバックが設定されていないか、ライブラリが初期化されていない場合はNULL。
コールバックのシグネチャ:
void function_name(GLFWwindow* window, int width, int height)コールバック・パラメータについては、関数ポインタ型を参照のこと。
エラー:
考えられるエラーはGLFW_NOT_INITIALIZED。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Framebuffer size
追加:
バージョン3.0で追加。
glfwSetWindowContentScaleCallback()
この関数は、指定されたウィンドウのコンテンツスケールが変更されたときに呼び出される、 指定されたウィンドウのウィンドウコンテンツスケールコールバックを設定します。
GLFWwindowcontentscalefun glfwSetWindowContentScaleCallback(GLFWwindow * window, GLFWwindowcontentscalefun callback)引数:
[in] window: コールバックを設定するウィンドウ。[in] callback: 新しいコールバック、または現在設定されているコールバックを削除する場合は NULL。
戻り値:
コールバックが設定されていないか、ライブラリが初期化されていない場合はNULL。
コールバックのシグネチャ:
void function_name(GLFWwindow* window, float xscale, float yscale)コールバック・パラメータについては、関数ポインタ型を参照のこと。
エラー:
考えられるエラーはGLFW_NOT_INITIALIZED。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Window content scale
- glfwGetWindowContentScale
追加:
バージョン3.3で追加。
glfwPollEvents()
この関数は、すでにイベント・キューに入っているイベントのみを処理し、すぐに戻る。イベントを処理すると、それらのイベントに関連するウィンドウ・コールバックと入力コールバックが呼び出される。
いくつかのプラットフォームでは、ウィンドウの移動、サイズ変更、メニュー操作によってイベント処理がブロックされます。これは、それらのプラットフォームでのイベント処理の設計方法によるものです。このような操作の間、必要に応じてウィンドウの内容を再描画するために、ウィンドウのリフレッシュ・コールバックを使用することができます。
設定したコールバックが、このようなイベント処理関数に応答してのみ呼び出されると思わないでください。イベントのためにポーリングすることは必要ですが、GLFWがそれ自身のコールバックを登録することを要求するウィンドウシステムは、多くのウィンドウシステム関数の呼び出しに応答してGLFWにイベントを渡すことができます。GLFWはこれらのイベントをアプリケーションのコールバックに渡してから返します。
ジョイスティック入力の動作にはイベント処理は必要ありません。
void glfwPollEvents(void)エラー:
起こりうるエラーはGLFW_NOT_INITIALIZEDとGLFW_PLATFORM_ERRORである。
リエントランシー:
この関数はコールバックから呼んではならない。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Event processing
- glfwWaitEvents
- glfwWaitEventsTimeout
追加:
バージョン1.0で追加。
glfwWaitEvents()
この関数は、イベントキューで少なくとも1つのイベントが利用可能になるまで、呼び出したスレッドをスリープさせる。すなわち、キュー内のイベントが処理され、関数はすぐに戻ります。イベントを処理すると、そのイベントに関連するウィンドウと入力のコールバックが呼び出されます。
すべてのイベントがコールバックに関連付けられているわけではないので、すべてのコールバックを監視している場合でも、コールバックが呼び出されずにこの関数が戻ることがあります。
プラットフォームによっては、ウィンドウの移動、サイズ変更、メニュー操作によってイベント処理がブロックされることがあります。これは、それらのプラットフォームでのイベント処理の設計方法によるものです。このような操作の間、必要に応じてウィンドウの内容を再描画するために、ウィンドウのリフレッシュ・コールバックを使用することができます。
設定したコールバックが、このようなイベント処理関数に応答してのみ呼び出されると思わないでください。イベントのためにポーリングすることは必要ですが、GLFWがそれ自身のコールバックを登録することを要求するウィンドウシステムは、多くのウィンドウシステム関数の呼び出しに応答してGLFWにイベントを渡すことができます。GLFWはこれらのイベントをアプリケーションのコールバックに渡してから返します。
ジョイスティック入力の動作にはイベント処理は必要ありません。
void glfwWaitEvents(void)エラー:
起こりうるエラーはGLFW_NOT_INITIALIZEDとGLFW_PLATFORM_ERRORである。
リエントランシー:
この関数はコールバックから呼んではならない。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Event processing
- glfwPollEvents
- glfwWaitEventsTimeout
追加:
バージョン2.5で追加。
glfwWaitEventsTimeout()
この関数は、イベントキューで少なくとも1つのイベントが利用可能になるまで、あるいは指定されたタイムアウトに達するまで、呼び出し元のスレッドをスリープさせる。つまり、キュー内のイベントが処理され、関数は直ちに戻ります。イベントを処理すると、そのイベントに関連するウィンドウと入力のコールバックが呼び出されます。
タイムアウト値は正の有限の数でなければなりません。
すべてのイベントがコールバックに関連付けられているわけではないので、すべてのコールバックを監視している場合でも、コールバックが呼び出されずにこの関数が戻ることがあります。
プラットフォームによっては、ウィンドウの移動、サイズ変更、メニュー操作によってイベント処理がブロックされることがあります。これは、それらのプラットフォームでのイベント処理の設計方法によるものです。このような操作の間、必要に応じてウィンドウの内容を再描画するために、ウィンドウのリフレッシュ・コールバックを使用することができます。
設定したコールバックが、このようなイベント処理関数に応答してのみ呼び出されると思わないでください。イベントのためにポーリングすることは必要ですが、GLFWがそれ自身のコールバックを登録することを要求するウィンドウシステムは、多くのウィンドウシステム関数の呼び出しに応答してGLFWにイベントを渡すことができます。GLFWはこれらのイベントをアプリケーションのコールバックに渡してから返します。
ジョイスティック入力の動作にはイベント処理は必要ありません。
void glfwWaitEventsTimeout(double timeout)引数:
[in] timeout: 最大待機時間（秒）。
エラー:
起こりうるエラーはGLFW_NOT_INITIALIZED、GLFW_INVALID_VALUE、GLFW_PLATFORM_ERRORである。
リエントランシー:
この関数はコールバックから呼んではならない。
スレッドセーフ:
この関数はメインスレッドからのみ呼び出されなければならない。
参照:
- Event processing
- glfwPollEvents
- glfwWaitEvents
追加:
バージョン3.2で追加。
glfwPostEmptyEvent()
この関数は、現在のスレッドからイベントキューに空のイベントをポストし、glfwWaitEvents または glfwWaitEventsTimeout を返す。
void glfwPostEmptyEvent(void)エラー:
起こりうるエラーはGLFW_NOT_INITIALIZEDとGLFW_PLATFORM_ERRORである。
スレッドセーフ:
この関数はどのスレッドからでも呼び出すことができる。
参照:
- Event processing
- glfwWaitEvents
- glfwWaitEventsTimeout
追加:
バージョン3.1で追加。
glfwSwapBuffers()
この関数は、OpenGLまたはOpenGL ESでレンダリングするときに、指定されたウィンドウの前面バッファと背面バッファを入れ替えます。スワップ間隔が0より大きい場合、GPUドライバはバッファをスワップする前に指定された画面更新回数を待ちます。
指定されたウィンドウはOpenGLまたはOpenGL ESのコンテキストを持っていなければなりません。コンテキストのないウィンドウを指定すると GLFW_NO_WINDOW_CONTEXT エラーが発生します。
この関数はVulkanには適用されません。Vulkanでレンダリングする場合は、代わりにvkQueuePresentKHRを参照してください。
void glfwSwapBuffers(GLFWwindow * window)引数:
[in] window: バッファを交換するウィンドウ。
エラー:
起こりうるエラーは GLFW_NOT_INITIALIZED、 GLFW_NO_WINDOW_CONTEXT、 GLFW_PLATFORM_ERROR です。
備考:
- EGL: 指定されたウィンドウのコンテキストは、呼び出し元のスレッドで最新でなければならない。
スレッドセーフ:
この関数はどのスレッドからでも呼び出すことができる。
参照:
- Buffer swapping
- glfwSwapInterval
追加:
バージョン1.0で追加。GLFW 3: ウィンドウハンドルパラメーターを追加。