1# drawing_sampling_options.h 2 3## 概述 4 5文件中定义了与采样相关的功能函数。用于图片或者纹理等图像的采样。 6 7**引用文件：** <native_drawing/drawing_sampling_options.h> 8 9**库：** libnative_drawing.so 10 11**起始版本：** 12 12 13**相关模块：** [Drawing](capi-drawing.md) 14 15## 汇总 16 17### 枚举 18 19| 名称 | typedef关键字 | 描述 | 20| -- | -- | -- | 21| [OH_Drawing_FilterMode](#oh_drawing_filtermode) | OH_Drawing_FilterMode | 过滤模式枚举。 | 22| [OH_Drawing_MipmapMode](#oh_drawing_mipmapmode) | OH_Drawing_MipmapMode | 多级渐远纹理模式枚举。 | 23 24### 函数 25 26| 名称 | 描述 | 27| -- | -- | 28| [OH_Drawing_SamplingOptions* OH_Drawing_SamplingOptionsCreate(OH_Drawing_FilterMode filterMode,OH_Drawing_MipmapMode mipmapMode)](#oh_drawing_samplingoptionscreate) | 创建一个采样选项对象。<br>本接口会产生错误码，可以通过[OH_Drawing_ErrorCodeGet](capi-drawing-error-code-h.md#oh_drawing_errorcodeget)查看错误码的取值。<br>mipmapMode不在枚举范围内时返回OH_DRAWING_ERROR_PARAMETER_OUT_OF_RANGE。 | 29| [OH_Drawing_SamplingOptions* OH_Drawing_SamplingOptionsCopy(OH_Drawing_SamplingOptions* samplingOptions)](#oh_drawing_samplingoptionscopy) | 创建一个采样选项对象副本[OH_Drawing_SamplingOptions](capi-drawing-oh-drawing-samplingoptions.md)，用于拷贝一个已有采样选项对象。<br> 本接口会产生错误码，可以通过[OH_Drawing_ErrorCodeGet](capi-drawing-error-code-h.md#oh_drawing_errorcodeget)查看错误码的取值。<br> samplingOptions为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。 | 30| [void OH_Drawing_SamplingOptionsDestroy(OH_Drawing_SamplingOptions* samplingOptions)](#oh_drawing_samplingoptionsdestroy) | 销毁采样选项对象并回收该对象占有内存。 | 31 32## 枚举类型说明 33 34### OH_Drawing_FilterMode 35 36``` 37enum OH_Drawing_FilterMode 38``` 39 40**描述** 41 42过滤模式枚举。 43 44**起始版本：** 12 45 46| 枚举项 | 描述 | 47| -- | -- | 48| FILTER_MODE_NEAREST | 邻近过滤模式。 | 49| FILTER_MODE_LINEAR | 线性过滤模式。 | 50 51### OH_Drawing_MipmapMode 52 53``` 54enum OH_Drawing_MipmapMode 55``` 56 57**描述** 58 59多级渐远纹理模式枚举。 60 61**起始版本：** 12 62 63| 枚举项 | 描述 | 64| -- | -- | 65| MIPMAP_MODE_NONE | 忽略多级渐远纹理级别。 | 66| MIPMAP_MODE_NEAREST | 邻近多级渐远级别采样。 | 67| MIPMAP_MODE_LINEAR | 两个邻近多级渐远纹理之间，线性插值采样。 | 68 69 70## 函数说明 71 72### OH_Drawing_SamplingOptionsCreate() 73 74``` 75OH_Drawing_SamplingOptions* OH_Drawing_SamplingOptionsCreate(OH_Drawing_FilterMode filterMode,OH_Drawing_MipmapMode mipmapMode) 76``` 77 78**描述** 79 80创建一个采样选项对象。<br>本接口会产生错误码，可以通过[OH_Drawing_ErrorCodeGet](capi-drawing-error-code-h.md#oh_drawing_errorcodeget)查看错误码的取值。<br>mipmapMode不在枚举范围内时返回OH_DRAWING_ERROR_PARAMETER_OUT_OF_RANGE。 81 82**系统能力：** SystemCapability.Graphic.Graphic2D.NativeDrawing 83 84**起始版本：** 12 85 86 87**参数：** 88 89| 参数项 | 描述 | 90| -- | -- | 91| [OH_Drawing_FilterMode](#oh_drawing_filtermode) filterMode | 过滤采样模式[OH_Drawing_FilterMode](capi-drawing-sampling-options-h.md#oh_drawing_filtermode)。 | 92| [OH_Drawing_MipmapMode](#oh_drawing_mipmapmode) mipmapMode | 多级渐远纹理采样模式[OH_Drawing_MipmapMode](capi-drawing-sampling-options-h.md#oh_drawing_mipmapmode)。 | 93 94**返回：** 95 96| 类型 | 说明 | 97| -- | -- | 98| [OH_Drawing_SamplingOptions](capi-drawing-oh-drawing-samplingoptions.md)* | 函数会返回一个指针，指针指向创建的采样选项对象[OH_Drawing_SamplingOptions](capi-drawing-oh-drawing-samplingoptions.md)。 | 99 100### OH_Drawing_SamplingOptionsCopy() 101 102``` 103OH_Drawing_SamplingOptions* OH_Drawing_SamplingOptionsCopy(OH_Drawing_SamplingOptions* samplingOptions) 104``` 105 106**描述** 107 108创建一个采样选项对象副本[OH_Drawing_SamplingOptions](capi-drawing-oh-drawing-samplingoptions.md)，用于拷贝一个已有采样选项对象。 109 110本接口会产生错误码，可以通过[OH_Drawing_ErrorCodeGet](capi-drawing-error-code-h.md#oh_drawing_errorcodeget)查看错误码的取值。 111 112samplingOptions为NULL时返回OH_DRAWING_ERROR_INVALID_PARAMETER。 113 114**系统能力：** SystemCapability.Graphic.Graphic2D.NativeDrawing 115 116**起始版本：** 20 117 118 119**参数：** 120 121| 参数项 | 描述 | 122| -- | -- | 123| [OH_Drawing_SamplingOptions](capi-drawing-oh-drawing-samplingoptions.md)* samplingOptions | 指向采样选项对象[OH_Drawing_SamplingOptions](capi-drawing-oh-drawing-samplingoptions.md)的指针。 | 124 125**返回：** 126 127| 类型 | 说明 | 128| -- | -- | 129| OH_Drawing_SamplingOptions* | 函数会返回一个指针，指针指向创建的采样选项对象副本[OH_Drawing_SamplingOptions](capi-drawing-oh-drawing-samplingoptions.md)。如果对象返回NULL，表示创建失败；可能的原因是可用内存为空，或者是samplingOptions为NULL。 | 130 131### OH_Drawing_SamplingOptionsDestroy() 132 133``` 134void OH_Drawing_SamplingOptionsDestroy(OH_Drawing_SamplingOptions* samplingOptions) 135``` 136 137**描述** 138 139销毁采样选项对象并回收该对象占有内存。 140 141**系统能力：** SystemCapability.Graphic.Graphic2D.NativeDrawing 142 143**起始版本：** 12 144 145**参数：** 146 147| 参数项 | 描述 | 148| -- | -- | 149| [OH_Drawing_SamplingOptions](capi-drawing-oh-drawing-samplingoptions.md)* samplingOptions | 指向采样选项对象[OH_Drawing_SamplingOptions](capi-drawing-oh-drawing-samplingoptions.md)的指针。 | 150 151 152