[Git][freetype/freetype][master] freetype.h: Mark 'COLR' v1 API as exper

Werner Lemberg pushed to branch master at FreeType / FreeType

Commits:

bcd73f7d
by Werner Lemberg at 2021-06-20T16:23:40+02:00
```
freetype.h: Mark 'COLR' v1 API as experimental.
```

2 changed files:

ChangeLog
include/freetype/freetype.h

Changes:

@@ -111,7 +111,7 @@
 -06-08  Werner Lemberg  <wl@gnu.org>
 -	Fix 'devel' build for COLR 'v1'.
 +	Fix 'devel' build for 'COLR' v1.
  	* devel/ftoption.h: Synchronize with
  	  `include/freetype/config/ftoption.h`.
@@ -127,7 +127,7 @@
 -06-08  Dominik Röttsches  <drott@chromium.org>
 -	[sfnt] Pointer validity check when reading COLR 'v1' layers
 +	[sfnt] Pointer validity check when reading 'COLR' v1 layers
  	* src/sfnt/ttcolr.c (tt_face_get_paint_layers): In addition to the
  	existing sanity checks, ensure that the pointer to the layer to be

include/freetype/freetype.h


    *   for both variable and non-variable formats.
    *
    * @since:
-   *   2.11
+   *   2.11 -- **currently experimental only!**  There might be changes
+   *   without retaining backward-compatibility of both the API and ABI.
    *
    */
   typedef enum  FT_PaintFormat_

    *     to `NULL` before the first call of @FT_Get_Colorline_Stops.
    *
    * @since:
-   *   2.11
+   *   2.11 -- **currently experimental only!**  There might be changes
+   *   without retaining backward-compatibility of both the API and ABI.
    *
    */
   typedef struct  FT_ColorStopIterator_

    *     Alpha transparency value multiplied with the value from 'CPAL'.
    *
    * @since:
-   *   2.11
+   *   2.11 -- **currently experimental only!**  There might be changes
+   *   without retaining backward-compatibility of both the API and ABI.
    *
    */
   typedef struct  FT_ColorIndex_

    *     The color information for this stop, see @FT_ColorIndex.
    *
    * @since:
-   *   2.11
+   *   2.11 -- **currently experimental only!**  There might be changes
+   *   without retaining backward-compatibility of both the API and ABI.
    *
    */
   typedef struct  FT_ColorStop_

    *   It describes how the gradient fill continues at the other boundaries.
    *
    * @since:
-   *   2.11
+   *   2.11 -- **currently experimental only!**  There might be changes
+   *   without retaining backward-compatibility of both the API and ABI.
    *
    */
   typedef enum  FT_PaintExtend_

    *     actual @FT_ColorStop's.
    *
    * @since:
-   *   2.11
+   *   2.11 -- **currently experimental only!**  There might be changes
+   *   without retaining backward-compatibility of both the API and ABI.
    *
    */
   typedef struct  FT_ColorLine_

    *     y translation.
    *
    * @since:
-   *   2.11
+   *   2.11 -- **currently experimental only!**  There might be changes
+   *   without retaining backward-compatibility of both the API and ABI.
    *
    */
   typedef struct  FT_Affine_23_

    *   'https://www.w3.org/TR/compositing-1/#porterduffcompositingoperators'.
    *
    * @since:
-   *   2.11
+   *   2.11 -- **currently experimental only!**  There might be changes
+   *   without retaining backward-compatibility of both the API and ABI.
    *
    */
   typedef enum  FT_Composite_Mode_

    *     to be provided.  Do not set this value.
    *
    * @since:
-   *   2.11
+   *   2.11 -- **currently experimental only!**  There might be changes
+   *   without retaining backward-compatibility of both the API and ABI.
    *
    */
   typedef struct  FT_Opaque_Paint_

    *     The layer iterator that describes the layers of this paint.
    *
    * @since:
-   *   2.11
+   *   2.11 -- **currently experimental only!**  There might be changes
+   *   without retaining backward-compatibility of both the API and ABI.
    *
    */
   typedef struct  FT_PaintColrLayers_

    *     The color information for this solid paint, see @FT_ColorIndex.
    *
    * @since:
-   *   2.11
+   *   2.11 -- **currently experimental only!**  There might be changes
+   *   without retaining backward-compatibility of both the API and ABI.
    *
    */
   typedef struct  FT_PaintSolid_

    *     Otherwise equal to~p0.
    *
    * @since:
-   *   2.11
+   *   2.11 -- **currently experimental only!**  There might be changes
+   *   without retaining backward-compatibility of both the API and ABI.
    *
    */
   typedef struct  FT_PaintLinearGradient_

    *     units).
    *
    * @since:
-   *   2.11
+   *   2.11 -- **currently experimental only!**  There might be changes
+   *   without retaining backward-compatibility of both the API and ABI.
    *
    */
   typedef struct  FT_PaintRadialGradient_

    *     from the (positive) y~axis.
    *
    * @since:
-   *   2.11
+   *   2.11 -- **currently experimental only!**  There might be changes
+   *   without retaining backward-compatibility of both the API and ABI.
    *
    */
   typedef struct  FT_PaintSweepGradient_

    *     information that is filled with paint.
    *
    * @since:
-   *   2.11
+   *   2.11 -- **currently experimental only!**  There might be changes
+   *   without retaining backward-compatibility of both the API and ABI.
    *
    */
   typedef struct  FT_PaintGlyph_

    *     this paint.
    *
    * @since:
-   *   2.11
+   *   2.11 -- **currently experimental only!**  There might be changes
+   *   without retaining backward-compatibility of both the API and ABI.
    *
    */
   typedef struct  FT_PaintColrGlyph_

    *     A 2x3 transformation matrix in @FT_Affine23 format.
    *
    * @since:
-   *   2.11
+   *   2.11 -- **currently experimental only!**  There might be changes
+   *   without retaining backward-compatibility of both the API and ABI.
    *
    */
   typedef struct  FT_PaintTransformed_

    *     Translation in y~direction (in font units).
    *
    * @since:
-   *   2.11
+   *   2.11 -- **currently experimental only!**  There might be changes
+   *   without retaining backward-compatibility of both the API and ABI.
    *
    */
   typedef struct  FT_PaintTranslate_

    *     units).
    *
    * @since:
-   *   2.11
+   *   2.11 -- **currently experimental only!**  There might be changes
+   *   without retaining backward-compatibility of both the API and ABI.
    *
    */
 

    *     The y~coordinate of the pivot point of the skew (in font units).
    *
    * @since:
-   *   2.11
+   *   2.11 -- **currently experimental only!**  There might be changes
+   *   without retaining backward-compatibility of both the API and ABI.
    *
    */
   typedef struct  FT_PaintSkew_

    *     `source_paint` is composited onto.
    *
    * @since:
-   *   2.11
+   *   2.11 -- **currently experimental only!**  There might be changes
+   *   without retaining backward-compatibility of both the API and ABI.
    *
    */
   typedef struct  FT_PaintComposite_

    *       * @FT_PaintColrGlyph
    *
    * @since:
-   *   2.11
+   *   2.11 -- **currently experimental only!**  There might be changes
+   *   without retaining backward-compatibility of both the API and ABI.
    *
    */
   typedef struct  FT_COLR_Paint_

    *     Do not output an initial root transform.
    *
    * @since:
-   *   2.11
+   *   2.11 -- **currently experimental only!**  There might be changes
+   *   without retaining backward-compatibility of both the API and ABI.
    *
    */
   typedef enum  FT_Color_Root_Transform_

    *   error, value~0 is returned also.
    *
    * @since:
-   *   2.11
+   *   2.11 -- **currently experimental only!**  There might be changes
+   *   without retaining backward-compatibility of both the API and ABI.
    *
    */
   FT_EXPORT( FT_Bool )

    *   object can not be retrieved or any other error occurs.
    *
    * @since:
-   *   2.11
+   *   2.11 -- **currently experimental only!**  There might be changes
+   *   without retaining backward-compatibility of both the API and ABI.
    *
    */
   FT_EXPORT( FT_Bool )

    *   also.
    *
    * @since:
-   *   2.11
+   *   2.11 -- **currently experimental only!**  There might be changes
+   *   without retaining backward-compatibility of both the API and ABI.
    *
    */
   FT_EXPORT( FT_Bool )

    *   this paint or any other error occured.
    *
    * @since:
-   *   2.11
+   *   2.11 -- **currently experimental only!**  There might be changes
+   *   without retaining backward-compatibility of both the API and ABI.
    *
    */
   FT_EXPORT( FT_Bool )

From:	Werner Lemberg (@wl)
Subject:	[Git][freetype/freetype][master] freetype.h: Mark 'COLR' v1 API as experimental.
Date:	Sun, 20 Jun 2021 14:27:23 +0000

...	...	@@ -4302,7 +4302,8 @@ FT_BEGIN_HEADER
4302	4302	* for both variable and non-variable formats.
4303	4303	*
4304	4304	* @since:
4305		- * 2.11
	4305	+ * 2.11 -- currently experimental only! There might be changes
	4306	+ * without retaining backward-compatibility of both the API and ABI.
4306	4307	*
4307	4308	*/
4308	4309	typedef enum FT_PaintFormat_
...	...	@@ -4349,7 +4350,8 @@ FT_BEGIN_HEADER
4349	4350	* to `NULL` before the first call of @FT_Get_Colorline_Stops.
4350	4351	*
4351	4352	* @since:
4352		- * 2.11
	4353	+ * 2.11 -- currently experimental only! There might be changes
	4354	+ * without retaining backward-compatibility of both the API and ABI.
4353	4355	*
4354	4356	*/
4355	4357	typedef struct FT_ColorStopIterator_
...	...	@@ -4379,7 +4381,8 @@ FT_BEGIN_HEADER
4379	4381	* Alpha transparency value multiplied with the value from 'CPAL'.
4380	4382	*
4381	4383	* @since:
4382		- * 2.11
	4384	+ * 2.11 -- currently experimental only! There might be changes
	4385	+ * without retaining backward-compatibility of both the API and ABI.
4383	4386	*
4384	4387	*/
4385	4388	typedef struct FT_ColorIndex_
...	...	@@ -4407,7 +4410,8 @@ FT_BEGIN_HEADER
4407	4410	* The color information for this stop, see @FT_ColorIndex.
4408	4411	*
4409	4412	* @since:
4410		- * 2.11
	4413	+ * 2.11 -- currently experimental only! There might be changes
	4414	+ * without retaining backward-compatibility of both the API and ABI.
4411	4415	*
4412	4416	*/
4413	4417	typedef struct FT_ColorStop_
...	...	@@ -4429,7 +4433,8 @@ FT_BEGIN_HEADER
4429	4433	* It describes how the gradient fill continues at the other boundaries.
4430	4434	*
4431	4435	* @since:
4432		- * 2.11
	4436	+ * 2.11 -- currently experimental only! There might be changes
	4437	+ * without retaining backward-compatibility of both the API and ABI.
4433	4438	*
4434	4439	*/
4435	4440	typedef enum FT_PaintExtend_
...	...	@@ -4460,7 +4465,8 @@ FT_BEGIN_HEADER
4460	4465	* actual @FT_ColorStop's.
4461	4466	*
4462	4467	* @since:
4463		- * 2.11
	4468	+ * 2.11 -- currently experimental only! There might be changes
	4469	+ * without retaining backward-compatibility of both the API and ABI.
4464	4470	*
4465	4471	*/
4466	4472	typedef struct FT_ColorLine_
...	...	@@ -4505,7 +4511,8 @@ FT_BEGIN_HEADER
4505	4511	* y translation.
4506	4512	*
4507	4513	* @since:
4508		- * 2.11
	4514	+ * 2.11 -- currently experimental only! There might be changes
	4515	+ * without retaining backward-compatibility of both the API and ABI.
4509	4516	*
4510	4517	*/
4511	4518	typedef struct FT_Affine_23_
...	...	@@ -4527,7 +4534,8 @@ FT_BEGIN_HEADER
4527	4534	* 'https://www.w3.org/TR/compositing-1/#porterduffcompositingoperators'.
4528	4535	*
4529	4536	* @since:
4530		- * 2.11
	4537	+ * 2.11 -- currently experimental only! There might be changes
	4538	+ * without retaining backward-compatibility of both the API and ABI.
4531	4539	*
4532	4540	*/
4533	4541	typedef enum FT_Composite_Mode_
...	...	@@ -4589,7 +4597,8 @@ FT_BEGIN_HEADER
4589	4597	* to be provided. Do not set this value.
4590	4598	*
4591	4599	* @since:
4592		- * 2.11
	4600	+ * 2.11 -- currently experimental only! There might be changes
	4601	+ * without retaining backward-compatibility of both the API and ABI.
4593	4602	*
4594	4603	*/
4595	4604	typedef struct FT_Opaque_Paint_
...	...	@@ -4617,7 +4626,8 @@ FT_BEGIN_HEADER
4617	4626	* The layer iterator that describes the layers of this paint.
4618	4627	*
4619	4628	* @since:
4620		- * 2.11
	4629	+ * 2.11 -- currently experimental only! There might be changes
	4630	+ * without retaining backward-compatibility of both the API and ABI.
4621	4631	*
4622	4632	*/
4623	4633	typedef struct FT_PaintColrLayers_
...	...	@@ -4643,7 +4653,8 @@ FT_BEGIN_HEADER
4643	4653	* The color information for this solid paint, see @FT_ColorIndex.
4644	4654	*
4645	4655	* @since:
4646		- * 2.11
	4656	+ * 2.11 -- currently experimental only! There might be changes
	4657	+ * without retaining backward-compatibility of both the API and ABI.
4647	4658	*
4648	4659	*/
4649	4660	typedef struct FT_PaintSolid_
...	...	@@ -4680,7 +4691,8 @@ FT_BEGIN_HEADER
4680	4691	* Otherwise equal to~p0.
4681	4692	*
4682	4693	* @since:
4683		- * 2.11
	4694	+ * 2.11 -- currently experimental only! There might be changes
	4695	+ * without retaining backward-compatibility of both the API and ABI.
4684	4696	*
4685	4697	*/
4686	4698	typedef struct FT_PaintLinearGradient_
...	...	@@ -4728,7 +4740,8 @@ FT_BEGIN_HEADER
4728	4740	* units).
4729	4741	*
4730	4742	* @since:
4731		- * 2.11
	4743	+ * 2.11 -- currently experimental only! There might be changes
	4744	+ * without retaining backward-compatibility of both the API and ABI.
4732	4745	*
4733	4746	*/
4734	4747	typedef struct FT_PaintRadialGradient_
...	...	@@ -4774,7 +4787,8 @@ FT_BEGIN_HEADER
4774	4787	* from the (positive) y~axis.
4775	4788	*
4776	4789	* @since:
4777		- * 2.11
	4790	+ * 2.11 -- currently experimental only! There might be changes
	4791	+ * without retaining backward-compatibility of both the API and ABI.
4778	4792	*
4779	4793	*/
4780	4794	typedef struct FT_PaintSweepGradient_
...	...	@@ -4806,7 +4820,8 @@ FT_BEGIN_HEADER
4806	4820	* information that is filled with paint.
4807	4821	*
4808	4822	* @since:
4809		- * 2.11
	4823	+ * 2.11 -- currently experimental only! There might be changes
	4824	+ * without retaining backward-compatibility of both the API and ABI.
4810	4825	*
4811	4826	*/
4812	4827	typedef struct FT_PaintGlyph_
...	...	@@ -4831,7 +4846,8 @@ FT_BEGIN_HEADER
4831	4846	* this paint.
4832	4847	*
4833	4848	* @since:
4834		- * 2.11
	4849	+ * 2.11 -- currently experimental only! There might be changes
	4850	+ * without retaining backward-compatibility of both the API and ABI.
4835	4851	*
4836	4852	*/
4837	4853	typedef struct FT_PaintColrGlyph_
...	...	@@ -4857,7 +4873,8 @@ FT_BEGIN_HEADER
4857	4873	* A 2x3 transformation matrix in @FT_Affine23 format.
4858	4874	*
4859	4875	* @since:
4860		- * 2.11
	4876	+ * 2.11 -- currently experimental only! There might be changes
	4877	+ * without retaining backward-compatibility of both the API and ABI.
4861	4878	*
4862	4879	*/
4863	4880	typedef struct FT_PaintTransformed_
...	...	@@ -4889,7 +4906,8 @@ FT_BEGIN_HEADER
4889	4906	* Translation in y~direction (in font units).
4890	4907	*
4891	4908	* @since:
4892		- * 2.11
	4909	+ * 2.11 -- currently experimental only! There might be changes
	4910	+ * without retaining backward-compatibility of both the API and ABI.
4893	4911	*
4894	4912	*/
4895	4913	typedef struct FT_PaintTranslate_
...	...	@@ -4928,7 +4946,8 @@ FT_BEGIN_HEADER
4928	4946	* units).
4929	4947	*
4930	4948	* @since:
4931		- * 2.11
	4949	+ * 2.11 -- currently experimental only! There might be changes
	4950	+ * without retaining backward-compatibility of both the API and ABI.
4932	4951	*
4933	4952	*/
4934	4953
...	...	@@ -4972,7 +4991,8 @@ FT_BEGIN_HEADER
4972	4991	* The y~coordinate of the pivot point of the skew (in font units).
4973	4992	*
4974	4993	* @since:
4975		- * 2.11
	4994	+ * 2.11 -- currently experimental only! There might be changes
	4995	+ * without retaining backward-compatibility of both the API and ABI.
4976	4996	*
4977	4997	*/
4978	4998	typedef struct FT_PaintSkew_
...	...	@@ -5012,7 +5032,8 @@ FT_BEGIN_HEADER
5012	5032	* `source_paint` is composited onto.
5013	5033	*
5014	5034	* @since:
5015		- * 2.11
	5035	+ * 2.11 -- currently experimental only! There might be changes
	5036	+ * without retaining backward-compatibility of both the API and ABI.
5016	5037	*
5017	5038	*/
5018	5039	typedef struct FT_PaintComposite_
...	...	@@ -5057,7 +5078,8 @@ FT_BEGIN_HEADER
5057	5078	* * @FT_PaintColrGlyph
5058	5079	*
5059	5080	* @since:
5060		- * 2.11
	5081	+ * 2.11 -- currently experimental only! There might be changes
	5082	+ * without retaining backward-compatibility of both the API and ABI.
5061	5083	*
5062	5084	*/
5063	5085	typedef struct FT_COLR_Paint_
...	...	@@ -5102,7 +5124,8 @@ FT_BEGIN_HEADER
5102	5124	* Do not output an initial root transform.
5103	5125	*
5104	5126	* @since:
5105		- * 2.11
	5127	+ * 2.11 -- currently experimental only! There might be changes
	5128	+ * without retaining backward-compatibility of both the API and ABI.
5106	5129	*
5107	5130	*/
5108	5131	typedef enum FT_Color_Root_Transform_
...	...	@@ -5196,7 +5219,8 @@ FT_BEGIN_HEADER
5196	5219	* error, value~0 is returned also.
5197	5220	*
5198	5221	* @since:
5199		- * 2.11
	5222	+ * 2.11 -- currently experimental only! There might be changes
	5223	+ * without retaining backward-compatibility of both the API and ABI.
5200	5224	*
5201	5225	*/
5202	5226	FT_EXPORT( FT_Bool )
...	...	@@ -5245,7 +5269,8 @@ FT_BEGIN_HEADER
5245	5269	* object can not be retrieved or any other error occurs.
5246	5270	*
5247	5271	* @since:
5248		- * 2.11
	5272	+ * 2.11 -- currently experimental only! There might be changes
	5273	+ * without retaining backward-compatibility of both the API and ABI.
5249	5274	*
5250	5275	*/
5251	5276	FT_EXPORT( FT_Bool )
...	...	@@ -5287,7 +5312,8 @@ FT_BEGIN_HEADER
5287	5312	* also.
5288	5313	*
5289	5314	* @since:
5290		- * 2.11
	5315	+ * 2.11 -- currently experimental only! There might be changes
	5316	+ * without retaining backward-compatibility of both the API and ABI.
5291	5317	*
5292	5318	*/
5293	5319	FT_EXPORT( FT_Bool )
...	...	@@ -5324,7 +5350,8 @@ FT_BEGIN_HEADER
5324	5350	* this paint or any other error occured.
5325	5351	*
5326	5352	* @since:
5327		- * 2.11
	5353	+ * 2.11 -- currently experimental only! There might be changes
	5354	+ * without retaining backward-compatibility of both the API and ABI.
5328	5355	*
5329	5356	*/
5330	5357	FT_EXPORT( FT_Bool )