WebSVN - AndroidProjects - Rev 356 - /libgdx-0.9.8/docs/api/com/badlogic/gdx/utils/ScreenUtils.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

<HTML>
<HEAD>

<TITLE>
ScreenUtils (libgdx API)
</TITLE>

<META NAME="date" CONTENT="2013-01-27">

<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">

<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ScreenUtils (libgdx API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>

</HEAD>

<BODY BGCOLOR="white" onload="windowTitle();">
<HR>


<A NAME="navbar_top"></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ScreenUtils.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>

libgdx API
<style>
body, td, th { font-family:Helvetica, Tahoma, Arial, sans-serif; font-size:10pt }
pre, code, tt { font-size:9pt; font-family:Lucida Console, Courier New, sans-serif }
h1, h2, h3, .FrameTitleFont, .FrameHeadingFont, .TableHeadingColor font { font-size:105%; font-weight:bold }
.TableHeadingColor { background:#EEEEFF; }
a { text-decoration:none }
a:hover { text-decoration:underline }
a:link, a:visited { color:blue }
table { border:0px }
.TableRowColor td:first-child { border-left:1px solid black }
.TableRowColor td { border:0px; border-bottom:1px solid black; border-right:1px solid black }
hr { border:0px; border-bottom:1px solid #333366; }
</style>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 <A HREF="../../../../com/badlogic/gdx/utils/Scaling.html" title="enum in com.badlogic.gdx.utils"><B>PREV CLASS</B></A> 
 <A HREF="../../../../com/badlogic/gdx/utils/SerializationException.html" title="class in com.badlogic.gdx.utils"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/badlogic/gdx/utils/ScreenUtils.html" target="_top"><B>FRAMES</B></A>  
 <A HREF="ScreenUtils.html" target="_top"><B>NO FRAMES</B></A>  
 <SCRIPT type="text/javascript">

</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>

</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>


<HR>

<H2>
<FONT SIZE="-1">
com.badlogic.gdx.utils</FONT>
<BR>
Class ScreenUtils</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.badlogic.gdx.utils.ScreenUtils</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>ScreenUtils</B><DT>extends java.lang.Object</DL>
</PRE>

<P>
Class with static helper methods that provide access to the default OpenGL FrameBuffer. These methods can be used to get the
entire screen content or a portion thereof.
<P>

<P>
<DL>
<DT><B>Author:</B></DT>
<DD>espitz</DD>
</DL>
<HR>

<P>



<A NAME="constructor_summary"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../com/badlogic/gdx/utils/ScreenUtils.html#ScreenUtils()">ScreenUtils</A></B>()</CODE>

<BR>
           </TD>
</TR>
</TABLE>
 


<A NAME="method_summary"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static byte[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/badlogic/gdx/utils/ScreenUtils.html#getFrameBufferPixels(boolean)">getFrameBufferPixels</A></B>(boolean flipY)</CODE>

<BR>
          Returns the default framebuffer contents as a byte[] array with a length equal to screen width * height * 4.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static byte[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/badlogic/gdx/utils/ScreenUtils.html#getFrameBufferPixels(int, int, int, int, boolean)">getFrameBufferPixels</A></B>(int x,
int y,
int w,
int h,
boolean flipY)</CODE>

<BR>
          Returns a portion of the default framebuffer contents specified by x, y, width and height, as a byte[] array with a length
equal to the specified width * height * 4.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../../../../com/badlogic/gdx/graphics/g2d/TextureRegion.html" title="class in com.badlogic.gdx.graphics.g2d">TextureRegion</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/badlogic/gdx/utils/ScreenUtils.html#getFrameBufferTexture()">getFrameBufferTexture</A></B>()</CODE>

<BR>
          Returns the default framebuffer contents as a <A HREF="../../../../com/badlogic/gdx/graphics/g2d/TextureRegion.html" title="class in com.badlogic.gdx.graphics.g2d"><CODE>TextureRegion</CODE></A> with a width and height equal to the current screen
size.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../../../../com/badlogic/gdx/graphics/g2d/TextureRegion.html" title="class in com.badlogic.gdx.graphics.g2d">TextureRegion</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/badlogic/gdx/utils/ScreenUtils.html#getFrameBufferTexture(int, int, int, int)">getFrameBufferTexture</A></B>(int x,
int y,
int w,
int h)</CODE>

<BR>
          Returns a portion of the default framebuffer contents specified by x, y, width and height as a <A HREF="../../../../com/badlogic/gdx/graphics/g2d/TextureRegion.html" title="class in com.badlogic.gdx.graphics.g2d"><CODE>TextureRegion</CODE></A> with
the same dimensions.</TD>
</TR>
</TABLE>
 <A NAME="methods_inherited_from_class_java.lang.Object"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
 
<P>



<A NAME="constructor_detail"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="ScreenUtils()"></A><H3>
ScreenUtils</H3>
<PRE>
public <B>ScreenUtils</B>()</PRE>
<DL>
</DL>



<A NAME="method_detail"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="getFrameBufferTexture()"></A><H3>
getFrameBufferTexture</H3>
<PRE>
public static <A HREF="../../../../com/badlogic/gdx/graphics/g2d/TextureRegion.html" title="class in com.badlogic.gdx.graphics.g2d">TextureRegion</A> <B>getFrameBufferTexture</B>()</PRE>
<DL>
<DD>Returns the default framebuffer contents as a <A HREF="../../../../com/badlogic/gdx/graphics/g2d/TextureRegion.html" title="class in com.badlogic.gdx.graphics.g2d"><CODE>TextureRegion</CODE></A> with a width and height equal to the current screen
size. The base <A HREF="../../../../com/badlogic/gdx/graphics/Texture.html" title="class in com.badlogic.gdx.graphics"><CODE>Texture</CODE></A> always has <A HREF="../../../../com/badlogic/gdx/math/MathUtils.html#nextPowerOfTwo(int)"><CODE>MathUtils.nextPowerOfTwo(int)</CODE></A> dimensions and RGBA8888 <A HREF="../../../../com/badlogic/gdx/graphics/Pixmap.Format.html" title="enum in com.badlogic.gdx.graphics"><CODE>Pixmap.Format</CODE></A>. It can be
accessed via <A HREF="../../../../com/badlogic/gdx/graphics/g2d/TextureRegion.html#getTexture()"><CODE>TextureRegion.getTexture()</CODE></A>. The texture is not managed and has to be reloaded manually on a context loss.
The returned TextureRegion is flipped along the Y axis by default.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getFrameBufferTexture(int, int, int, int)"></A><H3>
getFrameBufferTexture</H3>
<PRE>
public static <A HREF="../../../../com/badlogic/gdx/graphics/g2d/TextureRegion.html" title="class in com.badlogic.gdx.graphics.g2d">TextureRegion</A> <B>getFrameBufferTexture</B>(int x,
int y,
int w,
int h)</PRE>
<DL>
<DD>Returns a portion of the default framebuffer contents specified by x, y, width and height as a <A HREF="../../../../com/badlogic/gdx/graphics/g2d/TextureRegion.html" title="class in com.badlogic.gdx.graphics.g2d"><CODE>TextureRegion</CODE></A> with
the same dimensions. The base <A HREF="../../../../com/badlogic/gdx/graphics/Texture.html" title="class in com.badlogic.gdx.graphics"><CODE>Texture</CODE></A> always has <A HREF="../../../../com/badlogic/gdx/math/MathUtils.html#nextPowerOfTwo(int)"><CODE>MathUtils.nextPowerOfTwo(int)</CODE></A> dimensions and RGBA8888
<A HREF="../../../../com/badlogic/gdx/graphics/Pixmap.Format.html" title="enum in com.badlogic.gdx.graphics"><CODE>Pixmap.Format</CODE></A>. It can be accessed via <A HREF="../../../../com/badlogic/gdx/graphics/g2d/TextureRegion.html#getTexture()"><CODE>TextureRegion.getTexture()</CODE></A>. This texture is not managed and has to be reloaded
manually on a context loss. If the width and height specified are larger than the framebuffer dimensions, the Texture will
be padded accordingly. Pixels that fall outside of the current screen will have RGBA values of 0.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>x</CODE> - the x position of the framebuffer contents to capture<DD><CODE>y</CODE> - the y position of the framebuffer contents to capture<DD><CODE>w</CODE> - the width of the framebuffer contents to capture<DD><CODE>h</CODE> - the height of the framebuffer contents to capture</DL>
</DD>
</DL>
<HR>

<A NAME="getFrameBufferPixels(boolean)"></A><H3>
getFrameBufferPixels</H3>
<PRE>
public static byte[] <B>getFrameBufferPixels</B>(boolean flipY)</PRE>
<DL>
<DD>Returns the default framebuffer contents as a byte[] array with a length equal to screen width * height * 4. The byte[] will
always contain RGBA8888 data. Because of differences in screen and image origins the framebuffer contents should be flipped
along the Y axis if you intend save them to disk as a bitmap. Flipping is not a cheap operation, so use this functionality
wisely.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>flipY</CODE> - whether to flip pixels along Y axis</DL>
</DD>
</DL>
<HR>

<A NAME="getFrameBufferPixels(int, int, int, int, boolean)"></A><H3>
getFrameBufferPixels</H3>
<PRE>
public static byte[] <B>getFrameBufferPixels</B>(int x,
int y,
int w,
int h,
boolean flipY)</PRE>
<DL>
<DD>Returns a portion of the default framebuffer contents specified by x, y, width and height, as a byte[] array with a length
equal to the specified width * height * 4. The byte[] will always contain RGBA8888 data. If the width and height specified
are larger than the framebuffer dimensions, the Texture will be padded accordingly. Pixels that fall outside of the current
screen will have RGBA values of 0. Because of differences in screen and image origins the framebuffer contents should be
flipped along the Y axis if you intend save them to disk as a bitmap. Flipping is not cheap operation, so use this
functionality wisely.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>flipY</CODE> - whether to flip pixels along Y axis</DL>
</DD>
</DL>

<HR>


<A NAME="navbar_bottom"></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ScreenUtils.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
libgdx API</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 <A HREF="../../../../com/badlogic/gdx/utils/Scaling.html" title="enum in com.badlogic.gdx.utils"><B>PREV CLASS</B></A> 
 <A HREF="../../../../com/badlogic/gdx/utils/SerializationException.html" title="class in com.badlogic.gdx.utils"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/badlogic/gdx/utils/ScreenUtils.html" target="_top"><B>FRAMES</B></A>  
 <A HREF="ScreenUtils.html" target="_top"><B>NO FRAMES</B></A>  
 <SCRIPT type="text/javascript">

</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>

</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>


<HR>

<div style="font-size:9pt"><i>
Copyright 2010 Mario Zechner (contact@badlogicgames.com), Nathan Sweet (admin@esotericsoftware.com)
</i></div>

</BODY>
</HTML>

Subversion Repositories AndroidProjects

(root)/libgdx-0.9.8/docs/api/com/badlogic/gdx/utils/ScreenUtils.html - Rev 356