From 2ce076b3a6de7100c7975a4fa8f05a5767bc8a17 Mon Sep 17 00:00:00 2001 From: Annie_wang Date: Wed, 15 Jun 2022 17:53:52 +0800 Subject: [PATCH] update docs Signed-off-by: Annie_wang --- en/device_api/hdi/codec/codec_callback_if.h | 14 +-- en/device_api/hdi/codec/codec_component_if.h | 20 ++-- .../hdi/codec/codec_component_manager.h | 7 +- .../hdi/codec/codec_component_type.h | 38 ++++---- en/device_api/hdi/display/display_device.h | 94 +++++++++---------- en/device_api/hdi/display/display_gfx.h | 10 +- en/device_api/hdi/display/display_gralloc.h | 12 +-- en/device_api/hdi/display/display_layer.h | 43 +++++---- en/device_api/hdi/display/display_type.h | 52 +++++----- en/device_api/hdi/display/display_vgu.h | 54 +++++------ 10 files changed, 170 insertions(+), 174 deletions(-) diff --git a/en/device_api/hdi/codec/codec_callback_if.h b/en/device_api/hdi/codec/codec_callback_if.h index 0c686a04..24ad92bd 100644 --- a/en/device_api/hdi/codec/codec_callback_if.h +++ b/en/device_api/hdi/codec/codec_callback_if.h @@ -65,18 +65,18 @@ struct CodecCallbackType { * @brief Reports an event, such as an error, a command completion event, and port setting changes * during the running of a component. * - * When eEvent is OMX_EventCmdComplete, eventData is null, and data1 is - * OMX_COMMANDTYPE, data1 indicates a state, if data1 is OMX_CommandStateSet + * When event is OMX_EventCmdComplete, eventData is null, and data1 is + * OMX_COMMANDTYPE, data1 indicates a state if data1 is OMX_CommandStateSet * and indicates a port in other cases. - * If eEvent is OMX_EventError, data1 indicates an error code and data2 and + * If event is OMX_EventError, data1 indicates an error code and data2 and * eventData are both 0. - * If eEvent is OMX_EventMark, data1 and data2 are both 0 and + * If event is OMX_EventMark, data1 and data2 are both 0 and * eventData points to the mark. - * When eEvent is OMX_EventPortSettingsChanged, data1 indicates a port and + * When event is OMX_EventPortSettingsChanged, data1 indicates a port and * data2 and eventData are 0. - * When eEvent is OMX_EventBufferFlag, data1 indicates a port, data2 indicates a flag, + * When event is OMX_EventBufferFlag, data1 indicates a port, data2 indicates a flag, * and eventData is 0. - * When eEvent is OMX_EventResourcesAcquired or OMX_EventDynamicResourcesAvailable, + * When event is OMX_EventResourcesAcquired or OMX_EventDynamicResourcesAvailable, * the values of data1, data2, and eventData are 0. * * @param self Indicates the pointer to the callback to be invoked. diff --git a/en/device_api/hdi/codec/codec_component_if.h b/en/device_api/hdi/codec/codec_component_if.h index 6e4bf0df..c566230d 100644 --- a/en/device_api/hdi/codec/codec_component_if.h +++ b/en/device_api/hdi/codec/codec_component_if.h @@ -243,10 +243,10 @@ struct CodecComponentType { int32_t tunneledComp, uint32_t tunneledPort, struct OMX_TUNNELSETUPTYPE *tunnelSetup); /** - * @brief Specify the buffer of the component port. + * @brief Specifies the buffer of the component port. * * This API is used when: - * The component is in the OMX_StateLoaded state, and has sent a request for changing the state to OMX_StateIdle. + * The component in the OMX_StateLoaded state receives a request for changing the state to OMX_StateIdle. * The component is in the OMX_StateWaitForResources state, the required resources are available, * and the component is ready to enter the OMX_StateIdle state. * The component is in the OMX_StateExecuting, OMX_StatePause, or OMX_StateIdle state on a disabled port. @@ -268,7 +268,7 @@ struct CodecComponentType { * @brief Requests a port buffer from the component. * * This API is used to request a new buffer from a component when: - * The component is in the OMX_StateLoaded state and has sent a request for changing the state to OMX_StateIdle. + * The component in the OMX_StateLoaded state receives a request for changing the state to OMX_StateIdle. * The component is in the OMX_StateWaitForResources state, the required resources are available, * and the component is ready to enter the OMX_StateIdle state. * The component is in the OMX_StateExecuting, OMX_StatePause, or OMX_StateIdle state on a disabled port. @@ -290,7 +290,7 @@ struct CodecComponentType { * @brief Releases a buffer. * * This API is used to release a buffer when: - * The component is in the OMX_StateIdle state and has sent a request for changing the state to OMX_StateLoaded. + * The component in the OMX_StateIdle state receives a request for changing the state to OMX_StateLoaded. * The component is in the OMX_StateExecuting, OMX_StatePause, or OMX_StateIdle state on a disabled port. * This API can be called at any time. However, if it is not called in any of the previous conditions, * the component may report an OMX_ErrorPortUnpopulated event. @@ -309,7 +309,7 @@ struct CodecComponentType { int32_t (*FreeBuffer)(struct CodecComponentType *self, uint32_t portIndex, const struct OmxCodecBuffer *buffer); /** - * @brief Specify the buffer to be emptied by a component. + * @brief Empties the buffer for a component. * * This API should be called when the component is in the OMX_StateExecuting or OMX_StatePause state. * @@ -326,7 +326,7 @@ struct CodecComponentType { int32_t (*EmptyThisBuffer)(struct CodecComponentType *self, const struct OmxCodecBuffer *buffer); /** - * @brief Specify the buffer to be filled with the encoding and decoding output by a component. + * @brief Fills in the buffer of a component. * * This API should be called when the component is in the OMX_StateExecuting or OMX_StatePause state. * @@ -343,7 +343,7 @@ struct CodecComponentType { int32_t (*FillThisBuffer)(struct CodecComponentType *self, const struct OmxCodecBuffer *buffer); /** - * @brief Set a callback for the codec component. + * @brief Sets a callback for the codec component. * * This API is called to report an event or report available input or output information when the component * is in the OMX_StateLoaded state. @@ -367,7 +367,7 @@ struct CodecComponentType { /** * @brief Deinitializes a component. * - * This API can be called to close a component in the OMX_StateLoaded state. + * This API closes a component in the OMX_StateLoaded state. * * @param self Indicates the pointer to the codec component to close. * @@ -384,7 +384,7 @@ struct CodecComponentType { * @brief Uses the space allocated by EGL. * * This API is used when: - * The component is in the OMX_StateLoaded state and has sent a request for changing the state to OMX_StateIdle. + * The component in the OMX_StateLoaded state receives a request for changing the state to OMX_StateIdle. * The component is in the OMX_StateWaitForResources state, the required resources are available, * and the component is ready to enter the OMX_StateIdle state. * The component is in the OMX_StateExecuting, OMX_StatePause, or OMX_StateIdle state on a disabled port. @@ -413,7 +413,7 @@ struct CodecComponentType { * @param self Indicates the pointer to the target codec component. * @param role Indicates the pointer to the role name. * @param roleLen Indicates the length of the role, in bytes. - * @param index Indicates the index of a role. A component may support multiple roles. + * @param index Indicates the index of the role. A component may support multiple roles. * * @return Returns HDF_SUCCESS if the operation is successful. * @return Returns HDF_ERR_INVALID_PARAM if the operation failed due to invalid parameters. diff --git a/en/device_api/hdi/codec/codec_component_manager.h b/en/device_api/hdi/codec/codec_component_manager.h index e79fda61..a233c055 100644 --- a/en/device_api/hdi/codec/codec_component_manager.h +++ b/en/device_api/hdi/codec/codec_component_manager.h @@ -32,7 +32,7 @@ * @brief Provides APIs for managing the Codec component. * * The APIs can be used to obtain the component encoding and decoding capability list, - * and create or destroy components for the Codec module. + * and create or destroy codec components. * * @since 3.1 * @version 2.0 @@ -60,7 +60,7 @@ struct CodecComponentManager { /** * @brief Obtains the number of codec components. * - * All codec capability sets can be further obtained based on the number of codec components. + * The codec capability list can be further obtained based on the number of codec components. * * @return Returns the number of codec components obtained. * @@ -74,7 +74,7 @@ struct CodecComponentManager { * You can use this API to obtain the encoding and decoding capabilities provided by the Codec module. * The capability is represented in the {@link CodecCompCapability} structure. * - * @param capList Indicates the pointer to the component capability list {@link CodecCompCapability} obtained. + * @param capList Indicates the pointer to the {@link CodecCompCapability} obtained. * @param count Indicates the number of codec components, which is obtained by {@link GetComponentNum}. * * @return Returns HDF_SUCCESS if the operation is successful. @@ -89,7 +89,6 @@ struct CodecComponentManager { /** * @brief Creates a codec instance. * - * You can use this API to create a codec component instance based on the component name. * * @param component Indicates the pointer to the codec component created. * @param compName Indicates the name of the component to create. diff --git a/en/device_api/hdi/codec/codec_component_type.h b/en/device_api/hdi/codec/codec_component_type.h index 89abe1aa..df88c1b7 100644 --- a/en/device_api/hdi/codec/codec_component_type.h +++ b/en/device_api/hdi/codec/codec_component_type.h @@ -57,7 +57,7 @@ extern "C" { #define SAMPLE_FMT_NUM 32 /** - * @brief Defines the length of UUID. + * @brief Defines the length of a UUID. */ #define UUID_LENGTH 128 @@ -79,7 +79,7 @@ typedef enum { } AvCodecRole; /** - * @brief Enumerate the audio sampling formats. + * @brief Enumerates the audio sampling formats. * * For the planar sampling format, the data of each channel is independently stored in data. * For the packed sampling format, only the first data is used, and the data of each channel is interleaved. @@ -99,7 +99,7 @@ typedef enum { } AudioSampleFormat; /** - * @brief Size of the supported pixel format array. + * @brief Defines the size of the pixel format array supported. */ #define PIX_FORMAT_NUM 16 @@ -118,17 +118,17 @@ typedef struct { } VideoPortCap; /** - * @brief Size of the audio sampling format array supported. + * @brief Defines the size of the audio sampling format array supported. */ #define SAMPLE_FORMAT_NUM 12 /** - * @brief Size of the audio sampling rate array supported. + * @brief Defines the size of the audio sampling rate array supported. */ #define SAMPLE_RATE_NUM 16 /** - * @brief Size of the audio channel array supported. + * @brief Defines the size of the audio channel array supported. */ #define CHANNEL_NUM 16 @@ -153,12 +153,12 @@ typedef union { } PortCap; /** - * @brief Size of the component name. + * @brief Defines the component name. */ #define NAME_LENGTH 32 /** - * @brief Size of the profile array supported. + * @brief Defines the size of the profile array supported. */ #define PROFILE_NUM 256 @@ -192,7 +192,7 @@ enum CodecBufferType { }; /** - * @brief Enumerate the shared memory types. + * @brief Enumerates the shared memory types. */ enum ShareMemTypes { READ_WRITE_TYPE = 0x1, /**< Readable and writable shared memory */ @@ -230,32 +230,32 @@ enum OmxIndexCodecExType { }; /** - * @brief Enumerates the extended codec coding types. + * @brief Enumerates the extended coding types. */ enum OmxVideoExType { - OMX_VIDEO_CodingHEVC = 11, /**< HEVC coding type */ + OMX_VIDEO_CodingHEVC = 11, /**< HEVC */ }; /** * @brief Defines the component version information. */ struct CompVerInfo { - char compName[NAME_LENGTH]; /**< The name of the component. */ - uint8_t compUUID[UUID_LENGTH]; /**< The UUID of the component. */ - union OMX_VERSIONTYPE compVersion; /**< The version of the component. */ - union OMX_VERSIONTYPE specVersion; /**< The spec version of the component. */ + char compName[NAME_LENGTH]; /**< Name of the component. */ + uint8_t compUUID[UUID_LENGTH]; /**< UUID of the component. */ + union OMX_VERSIONTYPE compVersion; /**< Version of the component. */ + union OMX_VERSIONTYPE specVersion; /**< Version of the specifications based on which the component is built. */ }; /** * @brief Defines the event information. */ struct EventInfo { - int8_t *appData; /**< The pointer to the upper-layer instance passed to the callback. */ - uint32_t appDataLen; /**< The length of appData, in bytes. */ + int8_t *appData; /**< Pointer to the upper-layer instance passed to the callback. */ + uint32_t appDataLen; /**< Length of appData, in bytes. */ uint32_t data1; /**< Data 1 carried in the event. */ uint32_t data2; /**< Data 2 carried in the event. */ - int8_t *eventData; /**< The pointer of data carried in the event. */ - uint32_t eventDataLen; /**< The length of eventData, in bytes. */ + int8_t *eventData; /**< Pointer of data carried in the event. */ + uint32_t eventDataLen; /**< Length of eventData, in bytes. */ }; /** diff --git a/en/device_api/hdi/display/display_device.h b/en/device_api/hdi/display/display_device.h index af285b46..4eb4fdfd 100644 --- a/en/device_api/hdi/display/display_device.h +++ b/en/device_api/hdi/display/display_device.h @@ -51,8 +51,8 @@ extern "C" { * transferred to the graphics service through the current callback. It identifies the display device to connect. * @param connected Indicates the connection status of the display device. The value true means that the * display device is connected, and false means the opposite. - * @param data Indicates the private data carried by the graphics service. This parameter carries the private data - * address transferred when RegHotPlugCallback is called. For details, see {@link RegHotPlugCallback}. + * @param data Indicates the pointer to the private data carried by the graphics service. This parameter carries the private data + * address passed when RegHotPlugCallback is called. For details, see {@link RegHotPlugCallback}. * * * @since 1.0 @@ -101,7 +101,7 @@ typedef struct { * HotPlugCallback callback. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode} otherwise. + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 @@ -118,7 +118,7 @@ typedef struct { * VBlankCallback callback. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode} otherwise. + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 @@ -126,7 +126,7 @@ typedef struct { int32_t (*RegDisplayVBlankCallback)(uint32_t devId, VBlankCallback callback, void *data); /* * - * @brief Called when the graphics service needs to refresh data frames. + * @brief Registers the callback to be invoked when the graphics service needs to refresh data frames. * * @param devId Indicates the ID of the display device. * @param callback Indicates the instance used to notify the graphics service of the request for refreshing @@ -135,7 +135,7 @@ typedef struct { * RefreshCallback callback. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode} otherwise. + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 @@ -146,11 +146,11 @@ typedef struct { * @brief Obtains the capabilities of a display device. * * @param devId Indicates the ID of the display device. - * @param info Indicates the pointer to the capabilities supported by the display device. For details, + * @param info Indicates the pointer to the capabilities of the display device. For details, * see {@link DisplayCapability}. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode} otherwise. + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 @@ -167,7 +167,7 @@ typedef struct { * the mode is set or obtained. For details, see {@link DisplayModeInfo}. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode} otherwise. + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 @@ -194,7 +194,7 @@ typedef struct { * this parameter in this interface. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode} otherwise. + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 @@ -208,7 +208,7 @@ typedef struct { * @param status Indicates the pointer to the power status of the device. The status is written by this interface. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode} otherwise. + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 @@ -222,7 +222,7 @@ typedef struct { * @param status Indicates the power status to set. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode} otherwise. + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 @@ -237,7 +237,7 @@ typedef struct { * by this interface. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode} otherwise. + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 @@ -251,7 +251,7 @@ typedef struct { * @param level Indicates the backlight value to set. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode} otherwise. + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 @@ -263,11 +263,11 @@ typedef struct { * * @param devId Indicates the ID of the display device. * @param id Indicates the property ID returned by GetDisplayCapability. - * @param level Indicates the pointer to the property corresponding to the property ID. The property value is + * @param level Indicates the pointer to the property obtained. The property value is * written by this interface. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode} otherwise. + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 @@ -282,7 +282,7 @@ typedef struct { * @param value Indicates the property to set. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode} otherwise. + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 @@ -301,7 +301,7 @@ typedef struct { * The value true means that the framebuffer needs to be reset, and false means the opposite. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode} otherwise. + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 @@ -317,10 +317,10 @@ typedef struct { * @param devId Indicates the ID of the display device. * @param num Indicates the pointer to the number of layers whose composition types have changed. * @param Layers Indicates the pointer to the start address of the layer array. - * @param Layers Indicates the pointer to the start address of the composition type array. + * @param type Indicates the pointer to the start address of the composition type array. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode} otherwise. + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 @@ -337,7 +337,7 @@ typedef struct { * @param rect Indicates the pointer to the cropped region of the client buffer. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode} otherwise. + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 @@ -351,7 +351,7 @@ typedef struct { * @param rect Indicates the pointer to the display region. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode} otherwise. + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 @@ -370,7 +370,7 @@ typedef struct { * signaled state. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode} otherwise. + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 @@ -388,7 +388,7 @@ typedef struct { * @param rect Indicates the pointer to the start address of the rectangle array. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode} otherwise. + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 @@ -409,7 +409,7 @@ typedef struct { * vertical sync signal, and false means to disable it. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode}otherwise. + * @return returns an error code defined in {@link DispErrCode}otherwise. * * @since 1.0 * @version 1.0 @@ -425,7 +425,7 @@ typedef struct { * @param fences Indicates the pointer to the start address of the fence array. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode} otherwise. + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 @@ -440,7 +440,7 @@ typedef struct { * @param gamuts Indicates the pointer to the information about all color gamuts supported by the display device. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode} otherwise. + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 @@ -455,7 +455,7 @@ typedef struct { * by this interface. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode} otherwise. + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 @@ -469,7 +469,7 @@ typedef struct { * @param gamut Indicates the color gamut to set. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode} otherwise. + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 @@ -484,7 +484,7 @@ typedef struct { * by this interface. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode} otherwise. + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 @@ -498,7 +498,7 @@ typedef struct { * @param gamutMap Indicates the gamut map to set. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode} otherwise. + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 @@ -512,7 +512,7 @@ typedef struct { * @param matrix Indicates the pointer to the 4x4 color transformation matrix to set. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode} otherwise. + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 @@ -527,7 +527,7 @@ typedef struct { * by this interface. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode} otherwise. + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 @@ -542,7 +542,7 @@ typedef struct { * @param keys Indicates the pointer to the information about all HDR metadata keys supported by the display device. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode} otherwise. + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 @@ -556,12 +556,10 @@ typedef struct { * the hardware for display. * * @param devId Indicates the ID of the display device. - * @param num Indicates the pointer to the number of layers. - * @param layers Indicates the pointer to the start address of the layer array. * @param fences Indicates the pointer to the start address of the fence array. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode} otherwise. + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 @@ -577,7 +575,7 @@ typedef struct { * @param devId Indicates the ID of the display device. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode} otherwise. + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 @@ -595,7 +593,7 @@ typedef struct { * @param devId Indicates the pointer to the ID of the virtual display device created. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode} otherwise. + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 @@ -608,7 +606,7 @@ typedef struct { * @param devId Indicates the ID of the display device. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode} otherwise. + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 @@ -626,7 +624,7 @@ typedef struct { * @param fence Indicates the sync fence. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode} otherwise. + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 @@ -642,12 +640,12 @@ typedef struct { * @param devId Indicates the ID of the display device. * @param buffer Indicates the pointer to the buffer of the writeback endpoint data. * @param fence Indicates the pointer to the sync fence. When calling this interface, the graphics service needs - * to pass the release fence of the buffer to - * specify whether data can be written to the buffer. Then, acquire fence of the buffer needs to be written + * to pass the release fence of the buffer to specify whether data can be written to the buffer. + * Then, acquire fence of the buffer needs to be written * and sent to the graphics service to specify whether the writeback data has been written to the buffer. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode} otherwise. + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 @@ -667,7 +665,7 @@ typedef struct { * The format can be modified based on hardware requirements and returned to the graphics service. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode} otherwise. + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 @@ -680,7 +678,7 @@ typedef struct { * @param devId Indicates the ID of the display device. * * @return Returns 0 if the operation is successful; - * @returns an error code defined in {@link DispErrCode} otherwise. + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 @@ -696,8 +694,8 @@ typedef struct { * the double pointer to operate the display device. The memory is allocated during initialization, and therefore * the caller does not need to allocate the memory. * - * @return Returns 0 if the operation is successful; returns an error code defined - * in {@link DispErrCode} otherwise. + * @return Returns 0 if the operation is successful; + * @return returns an error code defined in {@link DispErrCode} otherwise. * * @since 1.0 * @version 1.0 diff --git a/en/device_api/hdi/display/display_gfx.h b/en/device_api/hdi/display/display_gfx.h index 1b9e770f..37c5a5d1 100644 --- a/en/device_api/hdi/display/display_gfx.h +++ b/en/device_api/hdi/display/display_gfx.h @@ -70,7 +70,7 @@ typedef struct { int32_t (*DeinitGfx)(void); /** - * @brief Fills a rectangle with a given color on the canvas. + * @brief Fills a rectangle with the given color on the canvas. * * @param surface Indicates the pointer to the canvas. * @param rect Indicates the pointer to the rectangle to fill. @@ -85,7 +85,7 @@ typedef struct { int32_t (*FillRect)(ISurface *surface, IRect *rect, uint32_t color, GfxOpt *opt); /** - * @brief Draws a rectangle with a given color on the canvas. + * @brief Draws a rectangle with the given color on the canvas. * * @param surface Indicates the pointer to the canvas. * @param rect Indicates the pointer to the rectangle to draw. @@ -100,7 +100,7 @@ typedef struct { int32_t (*DrawRectangle)(ISurface *surface, Rectangle *rect, uint32_t color, GfxOpt *opt); /** - * @brief Draws a straight line with a given color on the canvas. + * @brief Draws a straight line with the given color on the canvas. * * @param surface Indicates the pointer to the canvas. * @param line Indicates the pointer to the line to draw. @@ -114,7 +114,7 @@ typedef struct { int32_t (*DrawLine)(ISurface *surface, ILine *line, GfxOpt *opt); /** - * @brief Draws a circle with a specified center and radius on the canvas using a given color. + * @brief Draws a circle with the specified center and radius on the canvas in the given color. * * @param surface Indicates the pointer to the canvas. * @param circle Indicates the pointer to the circle to draw. @@ -177,7 +177,7 @@ typedef struct { int32_t GfxInitialize(GfxFuncs **funcs); /** - * @brief Deinitializes the hardware acceleration module to release the pointer to functions for hardware + * @brief Uninitializes the hardware acceleration module to release the pointer to functions for hardware * acceleration operations. * * @param funcs Indicates the pointer to the functions for hardware acceleration operations. diff --git a/en/device_api/hdi/display/display_gralloc.h b/en/device_api/hdi/display/display_gralloc.h index 288232c0..c33d07e2 100644 --- a/en/device_api/hdi/display/display_gralloc.h +++ b/en/device_api/hdi/display/display_gralloc.h @@ -132,7 +132,7 @@ typedef struct { /** * @brief Invalidates the cache to update it from memory. * - * @param handle Indicates the pointer to the buffer of the cache, which will been invalidated. + * @param handle Indicates the pointer to the buffer of the cache to be invalidated. * * @return Returns 0 if the operation is successful; returns an error code defined in {@link DispErrCode} * otherwise. @@ -142,10 +142,10 @@ typedef struct { int32_t (*InvalidateCache)(BufferHandle* handle); /** - * @brief Checks whether the given VerifyAllocInfo array is allocatable. + * @brief Checks whether the given VerifyAllocInfo array is allocatable. * - * @param num Indicates the size of infos array. - * @param infos Indicates the pointer to the VerifyAllocInfo array. + * @param num Indicates the size of infos array. + * @param infos Indicates the pointer to the VerifyAllocInfo array. * @param supporteds Indicates the pointer to the array that can be allocated. * * @return Returns 0 if the operation is successful; returns an error code defined in {@link DispErrCode} @@ -170,8 +170,8 @@ typedef struct { int32_t GrallocInitialize(GrallocFuncs **funcs); /** - * @brief Deinitializes the memory module to release the memory allocated to the pointer to functions for memory - * operations. + * @brief Deinitializes the memory module to release the memory allocated for memory operations. + * * * @param funcs Indicates the pointer to functions for memory operations. * diff --git a/en/device_api/hdi/display/display_layer.h b/en/device_api/hdi/display/display_layer.h index 2576042c..1fd1878d 100644 --- a/en/device_api/hdi/display/display_layer.h +++ b/en/device_api/hdi/display/display_layer.h @@ -135,8 +135,8 @@ typedef struct { * display device, and 4 indicates the last display device. * @param layerId Indicates the layer ID, which uniquely identifies a layer. You can perform operations on the layer * with the specified layer ID. - * @param visible Indicates the visibility to set for the layer. The value true means to set the layer to be - * visible, and false means the opposite. + * @param visible Indicates the visibility to set. The value true means to display the layer, + * and false means the opposite. * * @return Returns 0 if the operation is successful; returns an error code defined in {@link DispErrCode} * otherwise. @@ -153,7 +153,7 @@ typedef struct { * display device, and 4 indicates the last display device. * @param layerId Indicates the layer ID, which uniquely identifies a layer. You can perform operations on the layer * with the specified layer ID. - * @param visible Indicates the pointer to the obtained layer visibility. The value true indicates that the + * @param visible Indicates the pointer to the layer visibility. The value true indicates that the * layer is visible, and false indicates that the layer is invisible. * * @return Returns 0 if the operation is successful; returns an error code defined in {@link DispErrCode} @@ -188,7 +188,7 @@ typedef struct { * display device, and 4 indicates the last display device. * @param layerId Indicates the layer ID, which uniquely identifies a layer. You can perform operations on the layer * with the specified layer ID. - * @param rect Indicates the pointer to the obtained layer size. + * @param rect Indicates the pointer to the layer size obtained. * * @return Returns 0 if the operation is successful; returns an error code defined in {@link DispErrCode} * otherwise. @@ -240,7 +240,7 @@ typedef struct { * display device, and 4 indicates the last display device. * @param layerId Indicates the layer ID, which uniquely identifies a layer. You can perform operations on the layer * with the specified layer ID. - * @param zorder Indicates the pointer to the obtained z-order. The value is an integer ranging from 0 to 255. + * @param zorder Indicates the pointer to the z-order obtained. The value is an integer ranging from 0 to 255. * A larger z-order value indicates a higher layer. * * @return Returns 0 if the operation is successful; returns an error code defined in {@link DispErrCode} @@ -276,7 +276,7 @@ typedef struct { * display device, and 4 indicates the last display device. * @param layerId Indicates the layer ID, which uniquely identifies a layer. You can perform operations on the layer * with the specified layer ID. - * @param preMul Indicates the pointer to the obtained layer premultiplication flag. + * @param preMul Indicates the pointer to the layer premultiplication flag obtained. * * @return Returns 0 if the operation is successful; returns an error code defined in {@link DispErrCode} * otherwise. @@ -474,7 +474,7 @@ typedef struct { * display device, and 4 indicates the last display device. * @param layerId Indicates the layer ID, which uniquely identifies a layer. You can perform operations on the layer * with the specified layer ID. - * @param buffer Indicates the pointer to the obtained buffer. + * @param buffer Indicates the pointer to the buffer obtained. * * @return Returns 0 if the operation is successful; returns an error code defined in {@link DispErrCode} * otherwise. @@ -539,16 +539,15 @@ typedef struct { int32_t (*SnapShot)(uint32_t devId, LayerBuffer *buffer); /** - * @brief Set the visible region for a layer + * @brief Sets the visible region for a layer. * * * @param devId Indicates the ID of the display device. The value ranges from 0 to 4, where 0 indicates the first * display device, and 4 indicates the last display device. * @param layerId Indicates the layer ID, which uniquely identifies a layer. You can perform operations on the layer * with the specified layer ID. - * @param num Indicates the count of rect. the region contains multiple IRect, the num means how much rects in the - * region. - * @param rect Indicates the pointer of the rectes. + * @param num Indicates the number of rectangles in the visiable region. + * @param rect Indicates the pointer of the rectangles. * * @return Returns 0 if the operation is successful; returns an error code defined in {@link DispErrCode} * otherwise. @@ -558,7 +557,7 @@ typedef struct { int32_t (*SetLayerVisibleRegion)(uint32_t devId, uint32_t layerId, uint32_t num, IRect *rect); /** - * @brief Set the buffer for a layer. + * @brief Sets the buffer for a layer. * * * @param devId Indicates the ID of the display device. The value ranges from 0 to 4, where 0 indicates the first @@ -566,7 +565,7 @@ typedef struct { * @param layerId Indicates the layer ID, which uniquely identifies a layer. You can perform operations on the layer * with the specified layer ID. * @param buffer Indicates the pointer of the buffer handle. The buffer handle should contain all information of the - * buffer which will be used for composition. + * buffer to be used for composition. * @param fence Indicates the fd of a sync file. * * @return Returns 0 if the operation is successful; returns an error code defined in {@link DispErrCode} @@ -577,14 +576,14 @@ typedef struct { int32_t (*SetLayerBuffer)(uint32_t devId, uint32_t layerId, const BufferHandle *buffer, int32_t fence); /** - * @brief Extension interface + * @brief Invokes the display layer commands. * * * @param devId Indicates the ID of the display device. The value ranges from 0 to 4, where 0 indicates the first * display device, and 4 indicates the last display device. * @param layerId Indicates the layer ID, which uniquely identifies a layer. You can perform operations on the layer * with the specified layer ID. - * @param cmd Indicates extension cmd to be used to identify different intention. + * @param cmd Indicates the commands to be executed. * * @return Returns 0 if the operation is successful; returns an error code defined in {@link DispErrCode} * otherwise. @@ -594,14 +593,14 @@ typedef struct { int32_t (*InvokeLayerCmd)(uint32_t devId, uint32_t layerId, uint32_t cmd, ...); /** - * @brief set the composition type which the client expect + * @brief Sets the composition type. * * * @param devId Indicates the ID of the display device. The value ranges from 0 to 4, where 0 indicates the first * display device, and 4 indicates the last display device. * @param layerId Indicates the layer ID, which uniquely identifies a layer. You can perform operations on the layer * with the specified layer ID. - * @param type Indicates the composition type which the client expect. It may vary with the implementation. + * @param type Indicates the composition type to set. It may vary with the implementation. * * @return Returns 0 if the operation is successful; returns an error code defined in {@link DispErrCode} * otherwise. @@ -611,14 +610,14 @@ typedef struct { int32_t (*SetLayerCompositionType)(uint32_t devId, uint32_t layerId, CompositionType type); /** - * @brief set the blend type + * @brief Sets the blend type. * * * @param devId Indicates the ID of the display device. The value ranges from 0 to 4, where 0 indicates the first * display device, and 4 indicates the last display device. * @param layerId Indicates the layer ID, which uniquely identifies a layer. You can perform operations on the layer * with the specified layer ID. - * @param type Indicates blend type + * @param type Indicates the blend type to set. * * @return Returns 0 if the operation is successful; returns an error code defined in {@link DispErrCode} * otherwise. @@ -635,7 +634,7 @@ typedef struct { * display device, and 4 indicates the last display device. * @param layerId Indicates the layer ID, which uniquely identifies a layer. You can perform operations on the layer * with the specified layer ID. - * @param matrix Indicates the 4x4 color transformation matrix. + * @param matrix Indicates the pointer to the color transformation matrix to set. * * @return Returns 0 if the operation is successful; returns an error code defined in {@link DispErrCode} * otherwise. @@ -645,7 +644,7 @@ typedef struct { int32_t (*SetLayerColorTransform)(uint32_t devId, uint32_t layerId, const float *matrix); /** - * @brief Sets a color data space for a layer. + * @brief Sets the color data space for a layer. * * @param devId Indicates the ID of the display device. The value ranges from 0 to 4, where 0 indicates the first * display device, and 4 indicates the last display device. @@ -761,7 +760,7 @@ typedef struct { int32_t LayerInitialize(LayerFuncs **funcs); /** - * @brief Deinitializes the layer module to release the memory allocated to the pointer to functions for + * @brief Deinitializes the layer module to release the memory allocated for * layer operations. * * @param funcs Indicates the pointer to functions for layer operations. diff --git a/en/device_api/hdi/display/display_type.h b/en/device_api/hdi/display/display_type.h index 40f9bfd8..570eddd5 100644 --- a/en/device_api/hdi/display/display_type.h +++ b/en/device_api/hdi/display/display_type.h @@ -53,13 +53,13 @@ extern "C" { #endif /** - * @brief Enumerates return values of the functions. + * @brief Enumerates the return values of the functions. * */ typedef enum { DISPLAY_SUCCESS = 0, /**< Success */ DISPLAY_FAILURE = -1, /**< Failure */ - DISPLAY_FD_ERR = -2, /**< File handle (FD) error */ + DISPLAY_FD_ERR = -2, /**< File descriptor (FD) error */ DISPLAY_PARAM_ERR = -3, /**< Parameter error */ DISPLAY_NULL_PTR = -4, /**< Null pointer */ DISPLAY_NOT_SUPPORT = -5, /**< Unsupported feature */ @@ -69,14 +69,14 @@ typedef enum { } DispErrCode; /** - * @brief Enumerates layer types. + * @brief Enumerates the layer types. * */ typedef enum { LAYER_TYPE_GRAPHIC, /**< Graphic layer */ LAYER_TYPE_OVERLAY, /**< Overlay layer */ LAYER_TYPE_SDIEBAND, /**< Sideband layer */ - LAYER_TYPE_CURSOR, /**< Cursor Layer */ + LAYER_TYPE_CURSOR, /**< Cursor layer */ LAYER_TYPE_BUTT /**< Empty layer */ } LayerType; @@ -96,7 +96,7 @@ enum { }; /** - * @brief Enumerates pixel formats. + * @brief Enumerates the pixel formats. * */ typedef enum { @@ -138,7 +138,7 @@ typedef enum { } PixelFormat; /** - * @brief Enumerates transform types of images. + * @brief Enumerates the image transformation types. * */ typedef enum { @@ -150,9 +150,9 @@ typedef enum { } TransformType; /** - * @brief Enumerates image blending types. + * @brief Enumerates the image blending types. * - * The system combines images based on a specified blending type during hardware acceleration. + * The system combines images based on the specified blending type during hardware acceleration. * */ typedef enum { @@ -176,7 +176,7 @@ typedef enum { } BlendType; /** - * @brief Enumerates ROP types supported by hardware acceleration. + * @brief Enumerates the ROP types supported by hardware acceleration. * * ROP performs bitwise Boolean operations (including bitwise AND and bitwise OR) on the RGB color and * alpha values of the foreground bitmap with those of the background bitmap, and then outputs the result. @@ -203,7 +203,7 @@ typedef enum { } RopType; /** - * @brief Enumerates color key types supported by hardware acceleration. + * @brief Enumerates the color key types supported by hardware acceleration. * */ typedef enum { @@ -214,7 +214,7 @@ typedef enum { } ColorKey; /** - * @brief Enumerates mirror types supported by hardware acceleration. + * @brief Enumerates the mirror types supported by hardware acceleration. * */ typedef enum { @@ -225,7 +225,7 @@ typedef enum { } MirrorType; /** - * @brief Enumerates connection types of hot plugging. + * @brief Enumerates the hot plug types. * */ typedef enum { @@ -282,7 +282,7 @@ typedef struct { } BufferData; /** - * @brief Defines the buffer, which is used to store layer data. + * @brief Defines the buffer used to store layer data. * */ typedef struct { @@ -307,7 +307,7 @@ typedef struct { } IRect; /** - * @brief Stores surface information for hardware acceleration, such as draw image and bit blit. + * @brief Defines surface information for hardware acceleration, such as image drawing and bit blitting. * */ typedef struct { @@ -379,17 +379,17 @@ typedef struct { #define PROPERTY_NAME_LEN 50 /** - * @brief Defines property object which contains name, property id and value. + * @brief Defines a property object. * */ typedef struct { char name[PROPERTY_NAME_LEN]; /**< Name of the property */ - uint32_t propId; /**< Property id which was decided in the DRM internal */ - uint64_t value; /**< the value of property */ + uint32_t propId; /**< Property ID which was decided in the DRM internal */ + uint64_t value; /**< Property value */ } PropertyObject; /** - * @brief Enumerates interface types. + * @brief Enumerates the interface types. * */ typedef enum { @@ -408,7 +408,7 @@ typedef enum { } InterfaceType; /** - * @brief Defines the capability of the output. + * @brief Defines the output capability. */ typedef struct { char name[PROPERTY_NAME_LEN]; /**< Name of the output */ @@ -423,7 +423,7 @@ typedef struct { } DisplayCapability; /** - * @brief Defines output mode info. + * @brief Defines the output mode information. */ typedef struct { int32_t width; /**< Width in pixel */ @@ -448,10 +448,10 @@ typedef struct { */ typedef enum { - POWER_STATUS_ON, /**< The power status is on. */ - POWER_STATUS_STANDBY, /**< The power status is standby. */ - POWER_STATUS_SUSPEND, /**< The power status is suspended. */ - POWER_STATUS_OFF, /**< The power status is off. */ + POWER_STATUS_ON, /**< On */ + POWER_STATUS_STANDBY, /**< Standby */ + POWER_STATUS_SUSPEND, /**< Suspended */ + POWER_STATUS_OFF, /**< Off */ POWER_STATUS_BUTT } DispPowerStatus; @@ -461,8 +461,8 @@ typedef enum { typedef enum { COMPOSITION_CLIENT, /**< Client composition type. The composer should be the CPU or GPU. */ COMPOSITION_DEVICE, /**< Device composition type. The composer should be the hardware. */ - COMPOSITION_CURSOR, /**< Cursor composition type, used for cursor. */ - COMPOSITION_VIDEO, /**< Cursor composition type, used for video. */ + COMPOSITION_CURSOR, /**< Composition type used for cursor. */ + COMPOSITION_VIDEO, /**< Composition type used for video. */ COMPOSITION_BUTT } CompositionType; diff --git a/en/device_api/hdi/display/display_vgu.h b/en/device_api/hdi/display/display_vgu.h index 6214bfaa..9cca51b9 100644 --- a/en/device_api/hdi/display/display_vgu.h +++ b/en/device_api/hdi/display/display_vgu.h @@ -68,8 +68,8 @@ typedef enum { * */ typedef enum { - VGU_CAP_BLIT = (1 << 0), /* < Bit blit */ - VGU_CAP_BLIT_NUM = (1 << 1), /* < Maximum number of images that can be combined during bit blit */ + VGU_CAP_BLIT = (1 << 0), /* < Bit blitting */ + VGU_CAP_BLIT_NUM = (1 << 1), /* < Maximum number of images that can be combined during bit blitting */ VGU_CAP_PATH = (1 << 2), /* < Path filling and stroking */ VGU_CAP_FILTER_BLUR = (1 << 3), /* < Blur filter */ } VGUCapability; @@ -79,14 +79,14 @@ typedef enum { * */ typedef enum { - VGU_SUCCESS = 0, /* < The operation is successful. */ - VGU_NO_SUPPORT = -1, /* < This feature is not supported. */ - VGU_OPERATION_FAILED = -2, /* < The operation failed. */ - VGU_OUT_OF_MEMORY = -3, /* < The operation ran out of memory. */ - VGU_TIMEOUT = -4, /* < The operation times out. */ - VGU_INVALID_PARAMETER = -5, /* < One or more parameters are invalid. */ - VGU_BUSY = -6, /* < The device is busy. */ - VGU_NO_CONTEXT = -7, /* < There is no context specified. */ + VGU_SUCCESS = 0, /* < Operation successful */ + VGU_NO_SUPPORT = -1, /* < Feature not supported */ + VGU_OPERATION_FAILED = -2, /* < Operation failed */ + VGU_OUT_OF_MEMORY = -3, /* < Insufficient memory */ + VGU_TIMEOUT = -4, /* < Timeout */ + VGU_INVALID_PARAMETER = -5, /* < Invalid parameters */ + VGU_BUSY = -6, /* < Device busy */ + VGU_NO_CONTEXT = -7, /* < Lack of context */ } VGUResult; /* * @@ -203,7 +203,7 @@ typedef struct { } VGUPath; /* * - * @brief Enumerates transform types. + * @brief Enumerates the transform types. * */ typedef enum { @@ -212,7 +212,7 @@ typedef enum { VGU_TRANSFORM_ROTATE_90 = (1 << 2), /* < Rotate by 90 degrees */ VGU_TRANSFORM_ROTATE_180 = (1 << 3), /* < Rotate by 180 degrees */ VGU_TRANSFORM_ROTATE_270 = (1 << 4), /* < Rotate by 270 degrees */ - VGU_TRANSFORM_OTHER = (1 << 16) /* < Other transform type */ + VGU_TRANSFORM_OTHER = (1 << 16) /* < Other type */ } VGUTransformType; /* * @@ -225,7 +225,7 @@ typedef struct { } VGUMatrix3; /* * - * @brief Stores bitmap information for hardware acceleration. + * @brief Defines bitmap information for hardware acceleration. * */ typedef struct { @@ -238,13 +238,13 @@ typedef struct { } VGUBuffer; /* * - * @brief Enumerates clip types of a surface. + * @brief Enumerates the clip types of a surface. * */ typedef enum { VGU_CLIP_RECT = 0, /* < Rectangle clip (default value) */ VGU_CLIP_PATH, /* < Path clip */ - VGU_CLIP_BUTT /* < Invalid definition */ + VGU_CLIP_BUTT /* < Invalid clip */ } VGUClipType; /* * @@ -257,7 +257,7 @@ typedef struct { } VGUMaskLayer; /* * - * @brief Stores surface information for 2D hardware acceleration. + * @brief Defines the surface information for 2D hardware acceleration. * */ typedef struct { @@ -452,7 +452,7 @@ typedef struct { int32_t (*QueryCapability)(uint32_t cap); /* * - * @brief Fills the given path with a specified paint style. + * @brief Fills the given path with the specified paint style. * * @param target Indicates the pointer to the target surface. * @param path Indicates the pointer to the path object. @@ -469,7 +469,7 @@ typedef struct { const VGUPaintStyle *style); /* * - * @brief Strokes the given path with a specified paint style. + * @brief Strokes the given path with the specified paint style. * * @param target Indicates the pointer to the target surface. * @param path Indicates the pointer to the path object. @@ -500,7 +500,7 @@ typedef struct { /* * * @brief Blits an image to the target surface. * - * During bit blit, color space conversion (CSC) and transformation can be implemented. + * During bit blitting, color space conversion (CSC) and transformation can be implemented. * * @param target Indicates the pointer to the target surface. * @param src Indicates the pointer to the source image. @@ -515,7 +515,7 @@ typedef struct { /* * * @brief Blits multiple images to the target surface. * - * During bit blit, color space conversion (CSC) and transformation can be implemented. You can use this + * During bit blitting, CSC and transformation can be implemented. You can use this * function to combine multiple source images to the target surface. * To query the maximum number of source images allowed, call the QueryCapability function. * @@ -531,7 +531,7 @@ typedef struct { VGUResult (*RenderBlitN)(VGUSurface *target, const VGUImage *src, uint16_t count, uint32_t color); /* * - * @brief Clears a rectangle with a given color on the target surface. + * @brief Clears a rectangle with the given color on the target surface. * * @param target Indicates the pointer to the target surface. * @param rect Indicates the pointer to the rectangle to clear. If this parameter is null, the entire surface @@ -622,7 +622,7 @@ VGUResult VGUPathClear(VGUPath *path); VGUResult VGUMatrixIdentity(VGUMatrix3 *matrix); /* * - * @brief Scales a specified transformation matrix. + * @brief Scales a transformation matrix. * * @param matrix Indicates the pointer to the transformation matrix object. * @param xScale Indicates how much you want to scale the horizontal coordinate by. @@ -635,7 +635,7 @@ VGUResult VGUMatrixIdentity(VGUMatrix3 *matrix); VGUResult VGUMatrixScale(VGUMatrix3 *matrix, float xScale, float yScale); /* * - * @brief Rotates a specified transformation matrix. + * @brief Rotates a transformation matrix. * * @param matrix Indicates the pointer to the transformation matrix object. * @param degree Indicates the number of degrees to rotate. @@ -647,7 +647,7 @@ VGUResult VGUMatrixScale(VGUMatrix3 *matrix, float xScale, float yScale); VGUResult VGUMatrixRotate(VGUMatrix3 *matrix, float degree); /* * - * @brief Translates a specified transformation matrix. + * @brief Translates a transformation matrix. * * @param matrix Indicates the pointer to the transformation matrix object. * @param x Indicates how much you want to translate the horizontal coordinate by. @@ -660,7 +660,7 @@ VGUResult VGUMatrixRotate(VGUMatrix3 *matrix, float degree); VGUResult VGUMatrixTranslate(VGUMatrix3 *matrix, float x, float y); /* * - * @brief Adds color stops to a specified gradient. + * @brief Adds color stops to a gradient. * * @param gradient Indicates the pointer to the gradient object. * @param colorStop Indicates the pointer to the color stop array. @@ -673,7 +673,7 @@ VGUResult VGUMatrixTranslate(VGUMatrix3 *matrix, float x, float y); VGUResult VGUGradientColorStop(VGUGradient *gradient, const VGUColorStop *colorStop, uint32_t count); /* * - * @brief Clears color stops of a specified gradient. + * @brief Clears color stops of a gradient. * * @param gradient Indicates the pointer to the gradient object. * @@ -684,7 +684,7 @@ VGUResult VGUGradientColorStop(VGUGradient *gradient, const VGUColorStop *colorS VGUResult VGUGradientClearStop(VGUGradient *gradient); /* * - * @brief Sets a transformation matrix for a specified gradient. + * @brief Sets a transformation matrix for a gradient. * * @param gradient Indicates the pointer to the gradient object. * @param matrix Indicates the pointer to the transformation matrix object to set. -- Gitee