1 /*
2  * Copyright (c) 2023 Huawei Device Co., Ltd.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 #ifndef C_INCLUDE_DRAWING_PATH_EFFECT_H
17 #define C_INCLUDE_DRAWING_PATH_EFFECT_H
18 
19 /**
20  * @addtogroup Drawing
21  * @{
22  *
23  * @brief Provides functions such as 2D graphics rendering, text drawing, and image display.
24  *
25  * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing
26  *
27  * @since 12
28  * @version 1.0
29  */
30 
31 /**
32  * @file drawing_path_effect.h
33  *
34  * @brief Declares functions related to the <b>pathEffect</b> object in the drawing module.
35  *
36  * @since 12
37  * @version 1.0
38  */
39 
40 #include "drawing_types.h"
41 
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45 
46 /**
47  * @brief Creates an <b>OH_Drawing_PathEffect</b> object.
48  *
49  * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing
50  * @param intervals Indicates a array which contain an even number of entries.
51  * @param count Indicates the number of elements of the intervals array.
52  * @param phase Indicates the offset into intervals array.
53  * @return Returns the pointer to the <b>OH_Drawing_PathEffect</b> object created.
54  * @since 12
55  * @version 1.0
56  */
57 OH_Drawing_PathEffect* OH_Drawing_CreateDashPathEffect(float* intervals, int count, float phase);
58 
59 /**
60  * @brief Destroys an <b>OH_Drawing_PathEffect</b> object and reclaims the memory occupied by the object.
61  *
62  * @syscap SystemCapability.Graphic.Graphic2D.NativeDrawing
63  * @param OH_Drawing_PathEffect Indicates the pointer to an <b>OH_Drawing_PathEffect</b> object.
64  * @since 12
65  * @version 1.0
66  */
67 void OH_Drawing_PathEffectDestroy(OH_Drawing_PathEffect*);
68 
69 #ifdef __cplusplus
70 }
71 #endif
72 /** @} */
73 #endif
74