SDL_CreateRendererWithProperties

プロパティを指定してウィンドウの2Dレンダリングコンテキストを生成する

ヘッダ

SDL_Renderer * SDL_CreateRendererWithProperties(SDL_PropertiesID props);

props

設定するプロパティ

(SDL_Renderer *) 成功のときレンダリングコンテキスト, 失敗のときNULLを戻す. SDL_GetError()を呼んで詳細を知ることができる.

これらのプロパティに対応している:

SDL_PROP_RENDERER_CREATE_NAME_STRING: 使用するレンダリングドライバの名前. 特定の1つが必要
SDL_PROP_RENDERER_CREATE_WINDOW_POINTER: レンダリングを表示するウィンドウ. サーフェイスでソフトウェアレンダラを使用しないならば必要
SDL_PROP_RENDERER_CREATE_SURFACE_POINTER: レンダリングを表示するサーフェイス. ウィンドウでソフトウェアレンダラを使用しないならば必要
SDL_PROP_RENDERER_CREATE_OUTPUT_COLORSPACE_NUMBER: ディスプレイへの出力のためのSDL_Colorspaceの値. デフォルトはSDL_COLORSPACE_SRGB. direct3d11, direct3d12, metalレンダラは線形色空間とHDR出力に対応したSDL_COLORSPACE_SRGB_LINEARに対応している. SDL_COLORSPACE_SRGB_LINEARを選択した場合, 描画ではsRGB色空間を使用するが, 値は1.0を超えることができ, 浮動小数点(線形)形式のテクスチャをHDR表示で使用できる
SDL_PROP_RENDERER_CREATE_PRESENT_VSYNC_NUMBER: 0以外のとき更新周期と同期させる. このプロパティはSDL_SetRenderVSync()でレンダラに設定できる全ての値を設定できる

SDL GPUレンダラの場合 (SDL 3.4.0以降):

SDL_PROP_RENDERER_CREATE_GPU_DEVICE_POINTER: レンダラで使用するデバイス. 任意
SDL_PROP_RENDERER_CREATE_GPU_SHADERS_SPIRV_BOOLEAN: アプリケーションはSDL_GPURenderStateにSPIR-Vシェーダを提供できる. 任意
SDL_PROP_RENDERER_CREATE_GPU_SHADERS_DXIL_BOOLEAN: アプリケーションはSDL_GPURenderStateにDXILシェーダを提供できる. 任意
SDL_PROP_RENDERER_CREATE_GPU_SHADERS_MSL_BOOLEAN: アプリケーションはSDL_GPURenderStateにMSLシェーダを提供できる. 任意

vulkanレンダラの場合

SDL_PROP_RENDERER_CREATE_VULKAN_INSTANCE_POINTER: レンダラで使用するVkInstance. 任意
SDL_PROP_RENDERER_CREATE_VULKAN_SURFACE_NUMBER: レンダラで使用するVkSurfaceKHR. 任意
SDL_PROP_RENDERER_CREATE_VULKAN_PHYSICAL_DEVICE_POINTER: レンダラで使用するVkPhysicalDevice. 任意
SDL_PROP_RENDERER_CREATE_VULKAN_DEVICE_POINTER: レンダラで使用するVkDevice. 任意
SDL_PROP_RENDERER_CREATE_VULKAN_GRAPHICS_QUEUE_FAMILY_INDEX_NUMBER: レンダリングで使用するキューファミリのインデックス
SDL_PROP_RENDERER_CREATE_VULKAN_PRESENT_QUEUE_FAMILY_INDEX_NUMBER: 画面表示で使用するキューファミリのインデックス

この関数を呼べるのはメインスレッドのみである.

SDL 3.2.0以降