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

# SDL_RenderReadPixels

現在のレンダーターゲットのピクセルデータを読み込む

## 構文

`int SDL_RenderReadPixels(SDL_Renderer* renderer, const SDL_Rect* rect, Uint32 format, void* pixels, int pitch)`

## 引数

renderer | レンダリングコンテキスト
rect | 読み込む領域のSDL_Rect. NULLのときレンダリング対象全体
format | ピクセルデータのSDL_PixelFormat. 0のときレンダリング対象と同じ形式
pixels | ピクセルデータを代入するポインタ
pitch | 引数pixelsの水平方向のバイト数. 詳細を参照すること

## 戻り値

成功のとき0, 失敗のとき負の数のエラーコードを戻す. SDL_GetError()で詳細を知ることができる.

## 詳細

注意: この関数は非常に遅いので, 周期的な処理で使ってはならない.

pitchでpixelsの1行あたりのバイト数を指定する. これにより, より大きなpixels配列の一部の領域を利用したり, ピクセルデータの行をパッディングすることができる. 一般的には, これはピクセルデータの1行あたりのピクセル数に, 1ピクセルあたりのバイト数を掛けたものと等しくなければならない.

## バージョン

SDL 2.0.0以降

## SDL Wikiへのリンク

SDL_RenderReadPixels - SDL Wiki