目次 - API(機能別) - 2Dレンダリング - SDL_RenderGetMetalCommandEncoder

SDL_RenderGetMetalCommandEncoder

現在のレンダラのMetalコマンドエンコーダを得る

構文

void* SDL_RenderGetMetalCommandEncoder(SDL_Renderer* renderer)

引数

rendererレンダラ

戻り値

成功のときid<MTLRenderCommandEncoder>, レンダラがMetalでないとき, またはエラーが発生したときNULLを戻す.

詳細

この関数はvoid*を戻す. SDLはMetalのヘッダをインクルードしていないためである. しかし, id<MTLRenderCommandEncoder>にキャストしても安全である.

SDL 2.0.18以降では, MetalがSDLに描画可能なレンダラの提供を拒否した場合はNULLを戻すので注意すること. これはウィンドウが非表示/最小化/画面外のとき発生しうる. これはレンダーターゲットのコマンドエンコーダの場合は発生しない. ウィンドウの場合のみである. 戻り値を確認すること!

バージョン

SDL 2.0.8以降

関連項目(関数)

SDL_RenderGetMetalLayer

SDL Wikiへのリンク

SDL_RenderGetMetalCommandEncoder - SDL Wiki