Microsoft.Xna.Framework.Graphics

Class RenderTarget2D

java.lang.Object

Microsoft.Xna.Framework.Graphics.GraphicsResource

Microsoft.Xna.Framework.Graphics.Texture

Microsoft.Xna.Framework.Graphics.Texture2D

Microsoft.Xna.Framework.Graphics.RenderTarget2D

All Implemented Interfaces:

IDisposable

public class RenderTarget2D
extends Texture2D

Contains a 2D texture that can be used as a render target.

Author:

Halofreak1990

Field Summary

Fields

Modifier and Type	Field and Description
Event<EventArgs>	ContentLost Occurs when resources are lost due to a lost device event.

Fields inherited from class Microsoft.Xna.Framework.Graphics.Texture2D

height, width

Fields inherited from class Microsoft.Xna.Framework.Graphics.GraphicsResource

_parent, Disposing, Name, Tag

Constructor Summary

Constructors

Constructor and Description
RenderTarget2D(GraphicsDevice graphicsDevice, int width, int height) Creates an instance of this object.
RenderTarget2D(GraphicsDevice graphicsDevice, int width, int height, boolean mipMap, SurfaceFormat preferredFormat, DepthFormat preferredDepthFormat)
RenderTarget2D(GraphicsDevice graphicsDevice, int width, int height, boolean mipMap, SurfaceFormat preferredFormat, DepthFormat preferredDepthFormat, int preferredMultiSampleCount, RenderTargetUsage usage)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	Dispose(boolean disposing) Immediately releases the unmanaged resources used by this Object.
DepthFormat	getDepthStencilFormat() Gets the data format for the depth stencil data.
int	getMultiSampleCount() Gets the number of sample locations during multisampling.
RenderTargetUsage	getRenderTargetUsage() Gets or sets the render target usage.
boolean	IsContentLost() Determines if the index buffer data has been lost due to a lost device event.

Methods inherited from class Microsoft.Xna.Framework.Graphics.Texture2D

Bounds, FromStream, FromStream, GetData, GetData, GetData, Height, SaveAsJpeg, SaveAsPng, SetData, SetData, SetData, Width

Methods inherited from class Microsoft.Xna.Framework.Graphics.Texture

getFormat, getLevelCount

Methods inherited from class Microsoft.Xna.Framework.Graphics.GraphicsResource

Dispose, finalize, getGraphicsDevice, IsDisposed, raise_disposing, toString

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ContentLost

public final Event<EventArgs> ContentLost

Occurs when resources are lost due to a lost device event.

Constructor Detail

RenderTarget2D

public RenderTarget2D(GraphicsDevice graphicsDevice,
              int width,
              int height)

Creates an instance of this object.

Parameters:

graphicsDevice - The graphics device to associate with this render target resource.

width - Width, in pixels, of the render target. You can use graphicsDevice.PresentationParameters.BackBufferWidth to get the current screen width.

height - Height, in pixels, of the render target. You can use graphicsDevice.PresentationParameters.BackBufferHeight to get the current screen height.

RenderTarget2D

public RenderTarget2D(GraphicsDevice graphicsDevice,
              int width,
              int height,
              boolean mipMap,
              SurfaceFormat preferredFormat,
              DepthFormat preferredDepthFormat)

Parameters:

graphicsDevice -

width -

height -

mipMap -

preferredFormat -

preferredDepthFormat -

RenderTarget2D

public RenderTarget2D(GraphicsDevice graphicsDevice,
              int width,
              int height,
              boolean mipMap,
              SurfaceFormat preferredFormat,
              DepthFormat preferredDepthFormat,
              int preferredMultiSampleCount,
              RenderTargetUsage usage)

Parameters:

graphicsDevice -

width -

height -

mipMap -

preferredFormat -

preferredDepthFormat -

preferredMultiSampleCount -

usage -

Method Detail

getDepthStencilFormat

public DepthFormat getDepthStencilFormat()

Gets the data format for the depth stencil data.

IsContentLost

public boolean IsContentLost()

Determines if the index buffer data has been lost due to a lost device event.

getMultiSampleCount

public int getMultiSampleCount()

Gets the number of sample locations during multisampling.

getRenderTargetUsage

public RenderTargetUsage getRenderTargetUsage()

Gets or sets the render target usage.

Dispose

protected void Dispose(boolean disposing)

Description copied from class: GraphicsResource

Immediately releases the unmanaged resources used by this Object.

Overrides:

Dispose in class Texture2D