<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_17) on Sun Nov 03 15:35:44 CET 2013 -->
<title>ScreenUtils (libgdx API)
</title>
<meta name="date" content="2013-11-03">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ScreenUtils (libgdx API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.
</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview
</a></li>
<li><a href="package-summary.html">Package
</a></li>
<li class="navBarCell1Rev">Class
</li>
<li><a href="class-use/ScreenUtils.html">Use
</a></li>
<li><a href="package-tree.html">Tree
</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated
</a></li>
<li><a href="../../../../index-all.html">Index
</a></li>
<li><a href="../../../../help-doc.html">Help
</a></li>
</ul>
<div class="aboutLanguage"><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></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/badlogic/gdx/utils/Scaling.html" title="enum in com.badlogic.gdx.utils"><span class="strong">Prev Class
</span></a></li>
<li><a href="../../../../com/badlogic/gdx/utils/Select.html" title="class in com.badlogic.gdx.utils"><span class="strong">Next Class
</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/badlogic/gdx/utils/ScreenUtils.html" target="_top">Frames
</a></li>
<li><a href="ScreenUtils.html" target="_top">No Frames
</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes
</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:
</li>
<li>Nested
|
</li>
<li>Field
|
</li>
<li><a href="#constructor_summary">Constr
</a> |
</li>
<li><a href="#method_summary">Method
</a></li>
</ul>
<ul class="subNavList">
<li>Detail:
</li>
<li>Field
|
</li>
<li><a href="#constructor_detail">Constr
</a> |
</li>
<li><a href="#method_detail">Method
</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.badlogic.gdx.utils
</div>
<h2 title="Class ScreenUtils" class="title">Class ScreenUtils
</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object
</li>
<li>
<ul class="inheritance">
<li>com.badlogic.gdx.utils.ScreenUtils
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class
<span class="strong">ScreenUtils
</span>
extends java.lang.Object
</pre>
<div class="block">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.
</div>
<dl><dt><span class="strong">Author:
</span></dt>
<dd>espitz
</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary
</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors
</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description
</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../com/badlogic/gdx/utils/ScreenUtils.html#ScreenUtils()">ScreenUtils
</a></strong>()
</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary
</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods
</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type
</th>
<th class="colLast" scope="col">Method and Description
</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static byte[]
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/utils/ScreenUtils.html#getFrameBufferPixels(boolean)">getFrameBufferPixels
</a></strong>(boolean
flipY)
</code>
<div class="block">Returns the default framebuffer contents as a byte[] array with a length equal to screen width * height * 4.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static byte[]
</code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/utils/ScreenUtils.html#getFrameBufferPixels(int, int, int, int, boolean)">getFrameBufferPixels
</a></strong>(int
x,
int
y,
int
w,
int
h,
boolean
flipY)
</code>
<div class="block">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.
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static
<a href="../../../../com/badlogic/gdx/graphics/Pixmap.html" title="class in com.badlogic.gdx.graphics">Pixmap
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/utils/ScreenUtils.html#getFrameBufferPixmap(int, int, int, int)">getFrameBufferPixmap
</a></strong>(int
x,
int
y,
int
w,
int
h)
</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static
<a href="../../../../com/badlogic/gdx/graphics/g2d/TextureRegion.html" title="class in com.badlogic.gdx.graphics.g2d">TextureRegion
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/utils/ScreenUtils.html#getFrameBufferTexture()">getFrameBufferTexture
</a></strong>()
</code>
<div class="block">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.
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static
<a href="../../../../com/badlogic/gdx/graphics/g2d/TextureRegion.html" title="class in com.badlogic.gdx.graphics.g2d">TextureRegion
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/badlogic/gdx/utils/ScreenUtils.html#getFrameBufferTexture(int, int, int, int)">getFrameBufferTexture
</a></strong>(int
x,
int
y,
int
w,
int
h)
</code>
<div class="block">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.
</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class
java.lang.Object
</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail
</h3>
<a name="ScreenUtils()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ScreenUtils
</h4>
<pre>public
ScreenUtils()
</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail
</h3>
<a name="getFrameBufferTexture()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFrameBufferTexture
</h4>
<pre>public static
<a href="../../../../com/badlogic/gdx/graphics/g2d/TextureRegion.html" title="class in com.badlogic.gdx.graphics.g2d">TextureRegion
</a> getFrameBufferTexture()
</pre>
<div class="block">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.
</div>
</li>
</ul>
<a name="getFrameBufferTexture(int, int, int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFrameBufferTexture
</h4>
<pre>public static
<a href="../../../../com/badlogic/gdx/graphics/g2d/TextureRegion.html" title="class in com.badlogic.gdx.graphics.g2d">TextureRegion
</a> getFrameBufferTexture(int
x,
int
y,
int
w,
int
h)
</pre>
<div class="block">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.
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>x
</code> - the x position of the framebuffer contents to capture
</dd><dd><code>y
</code> - the y position of the framebuffer contents to capture
</dd><dd><code>w
</code> - the width of the framebuffer contents to capture
</dd><dd><code>h
</code> - the height of the framebuffer contents to capture
</dd></dl>
</li>
</ul>
<a name="getFrameBufferPixmap(int, int, int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFrameBufferPixmap
</h4>
<pre>public static
<a href="../../../../com/badlogic/gdx/graphics/Pixmap.html" title="class in com.badlogic.gdx.graphics">Pixmap
</a> getFrameBufferPixmap(int
x,
int
y,
int
w,
int
h)
</pre>
</li>
</ul>
<a name="getFrameBufferPixels(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFrameBufferPixels
</h4>
<pre>public static
byte[]
getFrameBufferPixels(boolean
flipY)
</pre>
<div class="block">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.
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>flipY
</code> - whether to flip pixels along Y axis
</dd></dl>
</li>
</ul>
<a name="getFrameBufferPixels(int, int, int, int, boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getFrameBufferPixels
</h4>
<pre>public static
byte[]
getFrameBufferPixels(int
x,
int
y,
int
w,
int
h,
boolean
flipY)
</pre>
<div class="block">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.
</div>
<dl><dt><span class="strong">Parameters:
</span></dt><dd><code>flipY
</code> - whether to flip pixels along Y axis
</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview
</a></li>
<li><a href="package-summary.html">Package
</a></li>
<li class="navBarCell1Rev">Class
</li>
<li><a href="class-use/ScreenUtils.html">Use
</a></li>
<li><a href="package-tree.html">Tree
</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated
</a></li>
<li><a href="../../../../index-all.html">Index
</a></li>
<li><a href="../../../../help-doc.html">Help
</a></li>
</ul>
<div class="aboutLanguage"><em>libgdx API
</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/badlogic/gdx/utils/Scaling.html" title="enum in com.badlogic.gdx.utils"><span class="strong">Prev Class
</span></a></li>
<li><a href="../../../../com/badlogic/gdx/utils/Select.html" title="class in com.badlogic.gdx.utils"><span class="strong">Next Class
</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/badlogic/gdx/utils/ScreenUtils.html" target="_top">Frames
</a></li>
<li><a href="ScreenUtils.html" target="_top">No Frames
</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes
</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:
</li>
<li>Nested
|
</li>
<li>Field
|
</li>
<li><a href="#constructor_summary">Constr
</a> |
</li>
<li><a href="#method_summary">Method
</a></li>
</ul>
<ul class="subNavList">
<li>Detail:
</li>
<li>Field
|
</li>
<li><a href="#constructor_detail">Constr
</a> |
</li>
<li><a href="#method_detail">Method
</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>
<div style="font-size:9pt"><i>
Copyright
© 2010-2013 Mario Zechner (contact@badlogicgames.com), Nathan Sweet (admin@esotericsoftware.com)
</i></div>
</small></p>
</body>
</html>