1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
6<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 7.0.0.0 for Windows">
7<META http-equiv="Content-Style-Type" content="text/css">
8<title>G2_GetBG2ScrPtr</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">G2_GetBG2ScrPtr <img src="../../image/NTR.gif"align="middle"><img src="../../image/TWL.gif" align="middle"></H1>
15<H2>Syntax</H2>
16
17<dl>
18  <dd>
19<PRE>
20<CODE>#include &lt;nitro/gx/g2.h&gt;</CODE><BR>
21<CODE>void *G2_GetBG2ScrPtr();</CODE></PRE></dd>
22</dl><h2>Arguments</h2>
23<P>None.</P>
24<h2>Return Values</h2>
25<P>The pointer to the region storing the BG2 screen.</P>
26<H2>Description</H2>
27<P>This function returns the pointer to the region where the Main 2D Engine BG2 screen data base is stored. The return values for character BGs are as follows:</P>
28<P> </P>
29<BLOCKQUOTE><CODE>HW_BG_VRAM</CODE><BR> + (Value at the end of the name in the <CODE>GXBGScrOffset</CODE> enumerated type specified by <CODE><A href="../gx/GX_SetBGScrOffset.html">GX_SetBGScrOffset</A></CODE>) <BR> + (Value at the end of the name in the <CODE>GXBGScrBase</CODE> enumerated type specified by <CODE><A href="G2_SetBG2ControlText.html">G2_SetBG2ControlText</A></CODE>)</BLOCKQUOTE>
30<P>The return values are as follows for bitmap BGs:</P>
31<BLOCKQUOTE><CODE>HW_BG_VRAM</CODE><BR> + (Value at the end of the name in the <CODE>GXBGBmpScrBase</CODE> enumerated type that is specified by <CODE><A href="G2_SetBG2Control256Bmp.html">G2_SetBG2Control256Bmp</A></CODE>)</BLOCKQUOTE>
32<P> </P>
33<h2>See Also</h2>
34<P><CODE><A href="G2_SetBG2ControlText.html">G2_SetBG2ControlText</A>, ... <A href="G2_SetBG2Priority.html">G2_SetBG2Priority</A>, <A href="G2_BG2Mosaic.html">G2_BG2Mosaic</A>, <A href="G2_GetBG2CharPtr.html">G2_GetBG2CharPtr</A>, <A href="G2_SetBG2Offset.html">G2_SetBG2Offset</A></CODE></P>
35<H2>Revision History</H2>
36<P>2006/03/01 Corrected description of bitmap BG.</P>
37<P>2004/02/09</P>
38<UL>
39  <LI>Added to description.
40</UL>
41<P>2004/01/19 Initial version.</P>
42<hr><p>CONFIDENTIAL</p></body>
43</html>
44