B.18. イメージ情報取得

B.18.1. clGetImageInfo

表B.51 表:clGetImageInfo

関数
cl_int
clGetImageInfo (
    cl_mem image,
    cl_image_info param_name,
    size_t param_value_size,
    void *param_value,
    size_t *param_value_size_ret
)
clCreateImageで生成したイメージオブ
ジェクトについての情報を取得。全てのメモリ
オブジェクト(バッファオブジェクトおよびイメ
ージオブジェクト)に共通の情報の取得には、
clGetMemObjectInfoを使用すること。
 引数
image
イメージオブジェクト
を指定。
param_name
取得する情報を指定。
param_value
param_nameに指定した
情報についての値が返さ
れるメモリ空間へのポ
インタ。NULLの場合は
無視。
param_value_
size
param_valueが指
すメモリのサイズを
バイトで指定。この
サイズは戻り値型の
サイズ以上となる必要
がある。
param_value_
size_ret
param_valueに
コピーされるデータ
の実際のサイズを
バイトで戻す。NULL
の場合は無視。
 成功した場合の戻り値
 CL_SUCCESS
 失敗した場合の戻り値
CL_INVALID_
VALUE
param_nameが
有効でない場合。

param_value_size
で指定したサイズ
(バイトで表す)が、
戻り値を下回る場合。
CL_INVALID_
MEM_OBJECT
imageが有効な
イメージオブジェクト
でない場合。
CL_OUT_OF_
RESOURCES
デバイス上のOpenCL
実装が必要とするリ
ソース確保に失敗し

た場合。
CL_OUT_OF_
HOST_MEMORY
ホスト上のOpenCL
実装が必要とするリ
ソース確保に失敗
した場合。

B.18.2. cl_image_info

表B.52 表:cl_image_info

cl_image_
info

戻り値型


param_value
に戻る情報
CL_IMAGE_
FORMAT
cl_image_
format

image を作成
する際に
clCreateImage
に指定したイメー
ジ形式記述子を
戻す
CL_IMAGE_
ELEMENT_SIZE
size_t
image が指す
イメージメモリオ
ブジェクトの画素
のサイズを戻す。
画素はn個のチャネ
ルからなる。nの値
はcl_image_
formatで与えられる。
CL_IMAGE_
ROW_PITCH

size_t


imageが指すイメ
ージオブジェクトの
行要素のrow pitch
のバイトサイズを戻す。

CL_IMAGE_
SLICE_PITCH
size_t
imageが指す3D
イメージオブジェク
トの2Dスライス、
1D/2Dイメージ配列
のバイトサイズを戻
す。

1D、1Dイメージ
バッファ、2Dイメ
ージオブジェクト
では、この値は0
になる。
CL_IMAGE_
WIDTH

size_t


イメージの幅を
ピクセルで戻す。

CL_IMAGE_
HEIGHT
size_t

イメージの高さを
ピクセルで返しま
す。1Dイメージ、
1Dイメージバッファ、
1Dイメージ配列オブ
ジェクトでは、
heightは0となる。

CL_IMAGE_
DEPTH
size_t
イメージの深さ
をピクセルで戻す。

1Dイメージ、
1Dイメージバッファ、
2Dイメージオブ
ジェクト、1D/2D
イメージ配列オブ
ジェクトでは、
depth=0となる。
CL_IMAGE_
ARRAY_SIZE

size_t

イメージ配列内の
イメージの個数を
戻す。イメージが
イメージ配列でな
い場合、0が戻る。
CL_IMAGE_
BUFFER

cl_mem

イメージに関連付
けられたバッファオ
ブジェクトを戻す。
CL_IMAGE_
NUM_MIP_LEVELS
cl_uint
イメージに関連付け
られた
num_mip_levels
を戻す。
CL_IMAGE_
NUM_SAMPLES

cl_uint


イメージに関連
付けられたnum_
samplesを戻す。

Copyright 2018-2019, by Masaki Komatsu