Layers Library - Revision history

Costel Mincea: Text replacement - "" to ""

2025-01-26T19:34:52Z

Text replacement - "<syntaxhighlight>" to "<syntaxhighlight lang="C" line>"

Steven Solie: /* Layers Example */

2015-11-04T17:43:19Z

Layers Example

← Older revision		Revision as of 17:43, 4 November 2015
Line 807:		Line 807:
	** (other than the InstallClipRegion() call) is through Intuition windows.		** (other than the InstallClipRegion() call) is through Intuition windows.
	**		**
	** See graphics primitives ~~chapter~~ for details on creating and using the		** See graphics primitives articles for details on creating and using the
	** low-level graphics calls.		** low-level graphics calls.
	*/		*/

Steven Solie: /* Layers Library */

2015-11-04T17:42:56Z

Layers Library

← Older revision		Revision as of 17:42, 4 November 2015
Line 2:		Line 2:
	== Layers Library ==		== Layers Library ==

	This ~~chapter~~ describes the layers library which provides routines that are used to manage overlapping rectangular drawing areas that share a common display. Intuition uses the layers library to manage its system of windows.		This article describes the layers library which provides routines that are used to manage overlapping rectangular drawing areas that share a common display. Intuition uses the layers library to manage its system of windows.

	The Graphics Library describes the use of ''regions'', special structures used to mask off areas where drawing can take place. Regions are installed through the layers library function InstallClipRegion() but the routines for the creation, disposal and manipulation of regions are part of the graphics library.		The Graphics Library describes the use of ''regions'', special structures used to mask off areas where drawing can take place. Regions are installed through the layers library function InstallClipRegion() but the routines for the creation, disposal and manipulation of regions are part of the graphics library.

Steven Solie: /* Layers Library */

2014-03-17T16:51:32Z

Layers Library

← Older revision		Revision as of 16:51, 17 March 2014
Line 4:		Line 4:
	This chapter describes the layers library which provides routines that are used to manage overlapping rectangular drawing areas that share a common display. Intuition uses the layers library to manage its system of windows.		This chapter describes the layers library which provides routines that are used to manage overlapping rectangular drawing areas that share a common display. Intuition uses the layers library to manage its system of windows.

	The ~~chapter~~ ~~also~~ describes the use of ''regions'', special structures used to mask off areas where drawing can take place. Regions are installed through the layers library function InstallClipRegion() but the routines for the creation, disposal and manipulation of regions are part of the graphics library.		The Graphics Library describes the use of ''regions'', special structures used to mask off areas where drawing can take place. Regions are installed through the layers library function InstallClipRegion() but the routines for the creation, disposal and manipulation of regions are part of the graphics library.

	== Layers ==		== Layers ==

Steven Solie: /* Regions */

2014-03-17T16:50:17Z

Regions

Show changes

Steven Solie at 16:49, 17 March 2014

2014-03-17T16:49:56Z

@@ Line 1,319: / Line 1,319: @@
 == Function Reference ==
-The following are brief descriptions of the layers library functions and related routines from the graphics library. See the SDK for details on each function call.
+The following are brief descriptions of the layers library functions. See the SDK for details on each function call.
 {| class="wikitable"
@@ Line 1,391: / Line 1,391: @@
 | InstallClipRegion()
 | Add a clipping region to a layer.
 |}

Steven Solie: /* Layers Example */

2014-03-17T16:32:02Z

Layers Example

Show changes

Steven Solie: /* Installing Regions */

2013-06-04T20:40:06Z

Installing Regions

← Older revision		Revision as of 20:40, 4 June 2013
Line 970:		Line 970:
	Use the function InstallClipRegion() to install the region.		Use the function InstallClipRegion() to install the region.

			<syntaxhighlight>
	<pre>
	struct Region InstallClipRegion( struct Layer layer, struct Region *region );		struct Region InstallClipRegion( struct Layer layer, struct Region *region );
			</syntaxhighlight>
	</pre>

	This installs a transparent clipping region to a layer. All subsequent graphics calls will be clipped to this region. The region must be removed with a second call to InstallClipRegion() before removing the layer.		This installs a transparent clipping region to a layer. All subsequent graphics calls will be clipped to this region. The region must be removed with a second call to InstallClipRegion() before removing the layer.

			<syntaxhighlight>
	<pre>
	/*		/*
	** Sample installation and removal of a clipping region		** Sample installation and removal of a clipping region
Line 986:		Line 986:
	** old_region will return NULL here.		** old_region will return NULL here.
	*/		*/
	old_region = InstallClipRegion(win-~~>~~WLayer, new_region);		old_region = ILayers->InstallClipRegion(win->WLayer, new_region);

	/* draw into the layer or window */		/* draw into the layer or window */

	if (NULL != (old_region = InstallClipRegion(win-~~>~~WLayer, old_region)))		if (NULL != (old_region = ILayers->InstallClipRegion(win->WLayer, old_region)))
	{		{
	/* throw the used region away. This region could be saved and		/* throw the used region away. This region could be saved and
	** used again later, if desired by the application.		** used again later, if desired by the application.
	*/		*/
	DisposeRegion(new_region) ;		ILayers->DisposeRegion(new_region) ;
	}		}
			</syntaxhighlight>
	</pre>

	{{Note\|title=A Warning About InstallClipRegion()\|text=The program must not call InstallClipRegion() inside of a Begin/EndRefresh() or Begin/EndUpdate() pair. The following code segment shows how to modify the user clipping region when using these calls. See the Autodoc for BeginRefresh() for more details.}}		{{Note\|title=A Warning About InstallClipRegion()\|text=The program must not call InstallClipRegion() inside of a Begin/EndRefresh() or Begin/EndUpdate() pair. The following code segment shows how to modify the user clipping region when using these calls. See the Autodoc for BeginRefresh() for more details.}}

			<syntaxhighlight>
	<pre>
	struct Region *new_region ;		struct Region *new_region ;
	struct Region *old_region ;		struct Region *old_region ;
Line 1,007:		Line 1,007:
	/* you have to have already setup the new_region and old_region */		/* you have to have already setup the new_region and old_region */

	BeginRefresh(window);		IIntuition->BeginRefresh(window);
	/* draw through the damage list */		/* draw through the damage list */
	/* into the layer or window */		/* into the layer or window */
	EndRefresh(window, FALSE); /* keep the damage list */		IIntuition->EndRefresh(window, FALSE); /* keep the damage list */

	old_region = InstallClipRegion(win-~~>~~WLayer, new_region);		old_region = ILayers->InstallClipRegion(win->WLayer, new_region);

	BeginRefresh(window);		IIntuition->BeginRefresh(window);
	/* draw through the damage list and the new_region */		/* draw through the damage list and the new_region */
	/* into the layer or window */		/* into the layer or window */
	EndRefresh(window, FALSE); /* keep the damage list */		IIntuition->EndRefresh(window, FALSE); /* keep the damage list */

	/* put back the old region */		/* put back the old region */
	new_region = InstallClipRegion(win-~~>~~WLayer, old_region);		new_region = ILayers->InstallClipRegion(win->WLayer, old_region);

	BeginRefresh(window);		IIntuition->BeginRefresh(window);
	EndRefresh(window, TRUE); /* remove the damage list */		IIntuition->EndRefresh(window, TRUE); /* remove the damage list */

	old_region = InstallClipRegion(win-~~>~~WLayer, new_region);		old_region = ILayers->InstallClipRegion(win->WLayer, new_region);

	BeginRefresh(window);		IIntuition->BeginRefresh(window);
	/* draw through the new_region only into the layer or window */		/* draw through the new_region only into the layer or window */
	EndRefresh(window, FALSE);		IIntuition->EndRefresh(window, FALSE);

	/* finally get rid of the new region, old_region still installed */		/* finally get rid of the new region, old_region still installed */
	if (NULL != (new_region = InstallClipRegion(win-~~>~~WLayer, old_region)))		if (NULL != (new_region = ILayers->InstallClipRegion(win->WLayer, old_region)))
	DisposeRegion(new_region) ;		ILayers->DisposeRegion(new_region) ;
			</syntaxhighlight>
	</pre>

	=== Changing a Region ===		=== Changing a Region ===

Steven Solie: /* Changing a Region */

2013-06-04T19:55:24Z

Changing a Region

← Older revision		Revision as of 19:55, 4 June 2013
Line 1,044:		Line 1,044:
	For instance:		For instance:

			<syntaxhighlight>
	<pre>
	extern struct Region RowRegion; / created elsewhere */		extern struct Region RowRegion; / created elsewhere */

	~~WORD~~ ktr;		int16 ktr;
	struct Rectangle rect;		struct Rectangle rect;

	for (ktr = 1; ktr ~~<~~ 6; ktr++)		for (ktr = 1; ktr < 6; ktr++)
	{		{
	rect.MinX = 50;		rect.MinX = 50;
Line 1,057:		Line 1,057:
	rect.MaxY = (ktr * 10);		rect.MaxY = (ktr * 10);

	if (!OrRectRegion(RowRegion, &~~amp;~~rect))		if (!ILayers->OrRectRegion(RowRegion, &rect))
	clean_exit(RETURN_WARN);		clean_exit(RETURN_WARN);
	}		}
			</syntaxhighlight>
	</pre>

	==== Rectangles and Regions ====		==== Rectangles and Regions ====

Steven Solie: /* Rectangles and Regions */

2013-06-04T19:54:17Z

Rectangles and Regions

← Older revision		Revision as of 19:54, 4 June 2013
Line 1,066:		Line 1,066:
	There are four functions for changing a region through logical operations with a rectangle.		There are four functions for changing a region through logical operations with a rectangle.

			<syntaxhighlight>
	<pre>
	BOOL OrRectRegion ( struct Region region, struct Rectangle rectangle );		BOOL OrRectRegion ( struct Region region, struct Rectangle rectangle );
	VOID AndRectRegion ( struct Region region, struct Rectangle rectangle );		VOID AndRectRegion ( struct Region region, struct Rectangle rectangle );
	BOOL XorRectRegion ( struct Region region, struct Rectangle rectangle );		BOOL XorRectRegion ( struct Region region, struct Rectangle rectangle );
	BOOL ClearRectRegion( struct Region region, struct Rectangle rectangle );		BOOL ClearRectRegion( struct Region region, struct Rectangle rectangle );
			</syntaxhighlight>
	</pre>

	OrRectRegion() modifies a region structure by '''OR''''ing a clipping rectangle into the region. When the application draws through this region (assuming that the region was originally empty), only the pixels within the clipping rectangle will be affected. If the region already has drawable areas, they will still exist, this rectangle is added to the drawable area.		OrRectRegion() modifies a region structure by '''OR''''ing a clipping rectangle into the region. When the application draws through this region (assuming that the region was originally empty), only the pixels within the clipping rectangle will be affected. If the region already has drawable areas, they will still exist, this rectangle is added to the drawable area.