drawing_sampling_options.h
Overview
This file declares the functions related to sampling in the drawing module. It is used for image or texture sampling.
File to include: <native_drawing/drawing_sampling_options.h>
Library: libnative_drawing.so
System capability: SystemCapability.Graphic.Graphic2D.NativeDrawing
Since: 12
Related module: Drawing
Summary
Enumerated value
| Name | typedef Keyword | Description |
|---|---|---|
| OH_Drawing_FilterMode | OH_Drawing_FilterMode | Defines an enum for the filter modes. |
| OH_Drawing_MipmapMode | OH_Drawing_MipmapMode | Defines an enum for the mipmap modes. |
Functions
| Name | Description |
|---|---|
| OH_Drawing_SamplingOptions* OH_Drawing_SamplingOptionsCreate(OH_Drawing_FilterMode filterMode,OH_Drawing_MipmapMode mipmapMode) | Creates an OH_Drawing_SamplingOptions object. This API may return an error code. For details, call OH_Drawing_ErrorCodeGet. If mipmapMode is not set to one of the enumerated values, OH_DRAWING_ERROR_PARAMETER_OUT_OF_RANGE is returned. |
| OH_Drawing_SamplingOptions* OH_Drawing_SamplingOptionsCopy(OH_Drawing_SamplingOptions* samplingOptions) | Creates a copy of an OH_Drawing_SamplingOptions object. This API may return an error code. For details, call OH_Drawing_ErrorCodeGet. If samplingOptions is NULL, OH_DRAWING_ERROR_INVALID_PARAMETER is returned. |
| void OH_Drawing_SamplingOptionsDestroy(OH_Drawing_SamplingOptions* samplingOptions) | Destroys an OH_Drawing_SamplingOptions object and reclaims the memory occupied by the object. |
Enum Description
OH_Drawing_FilterMode
enum OH_Drawing_FilterMode
Description
Defines an enum for the filter modes.
Since: 12
| Value | Description |
|---|---|
| FILTER_MODE_NEAREST | Nearest filter mode. |
| FILTER_MODE_LINEAR | Linear filter mode. |
OH_Drawing_MipmapMode
enum OH_Drawing_MipmapMode
Description
Defines an enum for the mipmap modes.
Since: 12
| Value | Description |
|---|---|
| MIPMAP_MODE_NONE | Mipmap level ignored. |
| MIPMAP_MODE_NEAREST | Nearest sampling from two adjacent mipmap levels. |
| MIPMAP_MODE_LINEAR | Linear interpolation sampling between two adjacent mipmap levels. |
Function Description
OH_Drawing_SamplingOptionsCreate()
OH_Drawing_SamplingOptions* OH_Drawing_SamplingOptionsCreate(OH_Drawing_FilterMode filterMode,OH_Drawing_MipmapMode mipmapMode)
Description
Creates an OH_Drawing_SamplingOptions object.
This API may return an error code. For details, call OH_Drawing_ErrorCodeGet.
If mipmapMode is not set to one of the enumerated values, OH_DRAWING_ERROR_PARAMETER_OUT_OF_RANGE is returned.
System capability: SystemCapability.Graphic.Graphic2D.NativeDrawing
Since: 12
Parameters
| Name | Description |
|---|---|
| OH_Drawing_FilterMode filterMode | Filter sampling mode. |
| OH_Drawing_MipmapMode mipmapMode | Mipmap mode. |
Returns
| Type | Description |
|---|---|
| OH_Drawing_SamplingOptions* | Returns a pointer to the created OH_Drawing_SamplingOptions object. |
OH_Drawing_SamplingOptionsCopy()
OH_Drawing_SamplingOptions* OH_Drawing_SamplingOptionsCopy(OH_Drawing_SamplingOptions* samplingOptions)
Description
Creates a copy of an OH_Drawing_SamplingOptions object.
This API may return an error code. For details, call OH_Drawing_ErrorCodeGet.
If samplingOptions is NULL, OH_DRAWING_ERROR_INVALID_PARAMETER is returned.
System capability: SystemCapability.Graphic.Graphic2D.NativeDrawing
Since: 20
Parameters
| Name | Description |
|---|---|
| OH_Drawing_SamplingOptions* samplingOptions | Pointer to the OH_Drawing_SamplingOptions object. |
Returns
| Type | Description |
|---|---|
| OH_Drawing_SamplingOptions* | Returns a pointer to the created OH_Drawing_SamplingOptions object copy. If NULL is returned, the creation fails. The possible failure cause is that no memory is available or samplingOptions is NULL. |
OH_Drawing_SamplingOptionsDestroy()
void OH_Drawing_SamplingOptionsDestroy(OH_Drawing_SamplingOptions* samplingOptions)
Description
Destroys an OH_Drawing_SamplingOptions object and reclaims the memory occupied by the object.
System capability: SystemCapability.Graphic.Graphic2D.NativeDrawing
Since: 12
Parameters
| Name | Description |
|---|---|
| OH_Drawing_SamplingOptions* samplingOptions | Pointer to the OH_Drawing_SamplingOptions object. |
你可能感兴趣的鸿蒙文章
openharmony 鸿蒙 capi-drawing-gpu-context-h
openharmony 鸿蒙 capi-drawing-nativepixelmap-
openharmony 鸿蒙 capi-nativevsync-oh-nativevsync-expectedraterange
openharmony 鸿蒙 capi-drawing-oh-drawing-brush
openharmony 鸿蒙 capi-drawing-oh-drawing-image-info
openharmony 鸿蒙 capi-drawing-text-linetypography-h
openharmony 鸿蒙 capi-oh-nativeimage-oh-nativeimage
openharmony 鸿蒙 capi-drawing-typeface-h