目次 - SDL 3.0 API(機能別) - ディスプレイとウィンドウ - SDL_GetWindowSurface

SDL_GetWindowSurface

ウィンドウに関連付けられたサーフェイスを得る

ヘッダ

SDL3/SDL_video.h

構文

SDL_Surface * SDL_GetWindowSurface(SDL_Window *window);

引数

SDL_Window *window問い合わせるウィンドウ

戻り値

(SDL_Surface *) ウィンドウに関連付けられたサーフェイスを戻す. 失敗のときNULLを戻す. SDL_GetError()を呼んで詳細を知ることができる.

詳細

必要な場合, 新しいサーフェイスがウィンドウに最適な形式で作成される. このサーフェイスはウィンドウが破棄されたとき解放される. このサーフェイスを解放してはならない.

このサーフェイスはウィンドウのサイズが変わると無効になる. ウィンドウのサイズを変えた後は, 有効なサーフェイスを得るためにこの関数を再び呼ぶ必要がある.

このウィンドウでは, このサーフェイスを3DまたはレンダリングAPIと結び付けることはできない.

この関数はSDL_HINT_FRAMEBUFFER_ACCELERATIONの影響を受ける.

スレッドセーフ

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

バージョン

SDL 3.2.0以降

関連項目

SDL Wikiへのリンク

SDL_GetWindowSurface - SDL Wiki