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

SDL_SetRenderTarget

レンダラの現在のレンダーターゲットを設定する

ヘッダ

SDL3/SDL_render.h

構文

bool SDL_SetRenderTarget(SDL_Renderer *renderer, SDL_Texture *texture);

引数

SDL_Renderer *rendererレンダリングコンテキスト
SDL_Texture *textureレンダーターゲットとなるテクスチャ. SDL_TEXTUREACCESS_TARGETフラグをつけて生成されている必要がある. NULLでデフォルトのレンダーターゲットに戻る

戻り値

(bool) 成功のとき真, 失敗のとき偽を戻す. SDL_GetError()を呼んで詳細を知ることができる.

詳細

デフォルトレンダーターゲットは, そのレンダラを生成したウィンドウで, その場合はNULLを戻す. テクスチャのレンダリングを止め, 再びウィンドウのレンダリングを行うには, この関数のtextureをNULLにすること.

レンダーターゲットにはそれぞれの描画領域, クリップ枠, 拡大率小, 論理サイズと表示モードがある. これらの状態の獲得と設定を行う関数は, この関数で設定したレンダーターゲットが対象で, これらの状態はレンダーターゲットが変わっても維持される.

スレッドセーフ

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

バージョン

SDL 3.2.0以降

関連項目

SDL Wikiへのリンク

SDL_SetRenderTarget - SDL Wiki