Microsoft.Xna.Framework.Graphics

Class GraphicsDevice

java.lang.Object

Microsoft.Xna.Framework.Graphics.GraphicsDevice

All Implemented Interfaces:

IDisposable

public class GraphicsDevice
extends java.lang.Object
implements IDisposable

Performs primitive-based rendering, creates resources, handles system-level variables, adjusts gamma ramp levels, and creates shaders.

Author:

Halofreak1990

Field Summary

Fields

Modifier and Type	Field and Description
Event<EventArgs>	DeviceLost
Event<EventArgs>	DeviceReset
Event<EventArgs>	DeviceResetting
Event<EventArgs>	Disposing
Event<ResourceCreatedEventArgs>	ResourceCreated
Event<ResourceDestroyedEventArgs>	ResourceDestroyed

Constructor Summary

Constructors

Constructor and Description
GraphicsDevice(GraphicsAdapter adapter, GraphicsProfile profile, PresentationParameters presentationParameters)

Method Summary

Methods

Modifier and Type	Method and Description
void	Clear(Color color)
void	Clear(java.util.EnumSet<ClearOptions> options, Color color, float depth, int stencil)
void	Clear(java.util.EnumSet<ClearOptions> options, Vector4 color, float depth, int stencil)
void	Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
protected void	Dispose(boolean disposing)
void	DrawIndexedPrimitives(PrimitiveType primitiveType, int baseVertex, int minVertexIndex, int numVertices, int startIndex, int primitiveCount) Renders the specified geometric primitive, based on indexing into an array of vertices.
void	DrawInstancedPrimitives(PrimitiveType primitiveType, int baseVertex, int minVertexIndex, int numVertices, int startIndex, int primitiveCount, int instanceCount) Draws a series of instanced models.
void	DrawPrimitives(PrimitiveType primitiveType, int startVertex, int primitiveCount) Renders a sequence of non-indexed geometric primitives of the specified type from the current set of data input streams.
<T extends ValueType & IVertexType> void	DrawUserIndexedPrimitives(PrimitiveType primitiveType, T[] vertexData, int vertexOffset, int numVertices, int[] indexData, int indexOffset, int primitiveCount) Renders indexed primitives from a 32-bit index buffer and other related input parameters.
<T extends ValueType> void	DrawUserIndexedPrimitives(PrimitiveType primitiveType, T[] vertexData, int vertexOffset, int numVertices, int[] indexData, int indexOffset, int primitiveCount, VertexDeclaration vertexDeclaration)
<T extends ValueType & IVertexType> void	DrawUserIndexedPrimitives(PrimitiveType primitiveType, T[] vertexData, int vertexOffset, int numVertices, short[] indexData, int indexOffset, int primitiveCount)
<T extends ValueType> void	DrawUserIndexedPrimitives(PrimitiveType primitiveType, T[] vertexData, int vertexOffset, int numVertices, short[] indexData, int indexOffset, int primitiveCount, VertexDeclaration vertexDeclaration)
<T extends ValueType & IVertexType> void	DrawUserPrimitives(PrimitiveType primitiveType, T[] vertexData, int vertexOffset, int primitiveCount)
<T extends ValueType> void	DrawUserPrimitives(PrimitiveType primitiveType, T[] vertexData, int vertexOffset, int primitiveCount, VertexDeclaration vertexDeclaration)
GraphicsAdapter	getAdapter()
<T extends java.lang.Number> void	GetBackBufferData(Rectangle rect, T[] data, int startIndex, int offset)
<T extends java.lang.Number> void	GetBackBufferData(T[] data)
<T extends java.lang.Number> void	GetBackBufferData(T[] data, int startIndex, int elementCount)
Color	getBlendFactor()
GraphicsProfile	getGraphicsProfile()
IndexBuffer	getIndices()
PresentationParameters	getPresentationParameters() Gets the presentation parameters associated with this graphics device.
RenderTargetBinding[]	GetRenderTargets()
TextureCollection	getTextures()
Viewport	getViewport()
void	Present()
void	Reset()
void	Reset(PresentationParameters presentationParameters)
void	Reset(PresentationParameters presentationParameters, GraphicsAdapter adapter)
void	setBlendFactor(Color value)
void	setIndices(IndexBuffer value)
void	SetRenderTarget(RenderTarget2D renderTarget) Sets a new render target for this GraphicsDevice.
void	SetRenderTarget(RenderTargetCube renderTarget, CubeMapFace cubeMapFace)
void	SetRenderTargets(RenderTargetBinding... renderTargets) Sets an array of RenderTargets.
void	SetVertexBuffer(VertexBuffer vertexBuffer) Sets or binds a vertex buffer to the device.
void	SetVertexBuffer(VertexBuffer vertexBuffer, int vertexOffset)
void	setViewport(Viewport value)

Methods inherited from class java.lang.Object

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

Field Detail

DeviceLost

public final Event<EventArgs> DeviceLost

DeviceReset

public final Event<EventArgs> DeviceReset

DeviceResetting

public final Event<EventArgs> DeviceResetting

Disposing

public final Event<EventArgs> Disposing

ResourceCreated

public final Event<ResourceCreatedEventArgs> ResourceCreated

ResourceDestroyed

public final Event<ResourceDestroyedEventArgs> ResourceDestroyed

Constructor Detail

GraphicsDevice

public GraphicsDevice(GraphicsAdapter adapter,
              GraphicsProfile profile,
              PresentationParameters presentationParameters)

Parameters:

adapter -

profile -

presentationParameters -

Throws:

ArgumentNullException

Method Detail

getAdapter

public GraphicsAdapter getAdapter()

getBlendFactor

public Color getBlendFactor()

setBlendFactor

public void setBlendFactor(Color value)

Parameters:

value -

getGraphicsProfile

public GraphicsProfile getGraphicsProfile()

getIndices

public IndexBuffer getIndices()

Returns:

setIndices

public void setIndices(IndexBuffer value)

Parameters:

value -

getPresentationParameters

public PresentationParameters getPresentationParameters()

Gets the presentation parameters associated with this graphics device.

getTextures

public TextureCollection getTextures()

Returns:

getViewport

public Viewport getViewport()

Returns:

setViewport

public void setViewport(Viewport value)

Parameters:

value -

Clear

public void Clear(Color color)

Parameters:

color -

Clear

public void Clear(java.util.EnumSet<ClearOptions> options,
         Color color,
         float depth,
         int stencil)

Parameters:

options -

color -

depth -

stencil -

Clear

public void Clear(java.util.EnumSet<ClearOptions> options,
         Vector4 color,
         float depth,
         int stencil)

Parameters:

options -

color -

depth -

stencil -

Dispose

public final void Dispose()

Description copied from interface: IDisposable

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Specified by:

Dispose in interface IDisposable

Dispose

protected void Dispose(boolean disposing)

Parameters:

disposing -

DrawIndexedPrimitives

public void DrawIndexedPrimitives(PrimitiveType primitiveType,
                         int baseVertex,
                         int minVertexIndex,
                         int numVertices,
                         int startIndex,
                         int primitiveCount)

Renders the specified geometric primitive, based on indexing into an array of vertices.

Parameters:

primitiveType - Describes the type of primitive to render. PrimitiveType.PointList is not supported with this method.

baseVertex - Offset to add to each vertex index in the index buffer.

minVertexIndex - Minimum vertex index for vertices used during the call. The minVertexIndex parameter and all of the indices in the index stream are relative to the baseVertex parameter.

numVertices - Number of vertices used during the call. The first vertex is located at index: baseVertex + minVertexIndex.

startIndex - Location in the index array at which to start reading vertices.

primitiveCount - Number of primitives to render. The number of vertices used is a function of primitiveCount and primitiveType.

DrawInstancedPrimitives

public void DrawInstancedPrimitives(PrimitiveType primitiveType,
                           int baseVertex,
                           int minVertexIndex,
                           int numVertices,
                           int startIndex,
                           int primitiveCount,
                           int instanceCount)

Draws a series of instanced models.

Parameters:

primitiveType - The primitive type.

baseVertex - Offset to add to each vertex index in the index buffer.

minVertexIndex - Minimum vertex index for vertices used during the call. The minVertexIndex parameter and all of the indices in the index stream are relative to the baseVertex parameter.

numVertices - Number of vertices used during the call. The first vertex is located at index: baseVertex + minVertexIndex.

startIndex - Location in the index array at which to start reading vertices.

primitiveCount - Number of primitives to render. The number of vertices used is a function of primitiveCount and primitiveType.

instanceCount - Number of primitives to render.

DrawPrimitives

public void DrawPrimitives(PrimitiveType primitiveType,
                  int startVertex,
                  int primitiveCount)

Renders a sequence of non-indexed geometric primitives of the specified type from the current set of data input streams.

Parameters:

primitiveType - Describes the type of primitive to render.

startVertex - Index of the first vertex to load. Beginning at startVertex, the correct number of vertices is read out of the vertex buffer.

primitiveCount - Number of primitives to render. The primitiveCount is the number of primitives as determined by the primitive type. If it is a line list, each primitive has two vertices. If it is a triangle list, each primitive has three vertices.

DrawUserIndexedPrimitives

public <T extends ValueType & IVertexType> void DrawUserIndexedPrimitives(PrimitiveType primitiveType,
                                                                T[] vertexData,
                                                                int vertexOffset,
                                                                int numVertices,
                                                                int[] indexData,
                                                                int indexOffset,
                                                                int primitiveCount)

Renders indexed primitives from a 32-bit index buffer and other related input parameters.

Parameters:

primitiveType - The primitive type.

vertexData - The vertex data.

vertexOffset - Offset (in vertices) from the beginning of the vertex buffer to the first vertex to draw.

numVertices - Number of vertices to draw.

indexData - The index data.

indexOffset - Offset (in indices) from the beginning of the index buffer to the first index to use.

primitiveCount - Number of primitives to render.

DrawUserIndexedPrimitives

public <T extends ValueType> void DrawUserIndexedPrimitives(PrimitiveType primitiveType,
                                                   T[] vertexData,
                                                   int vertexOffset,
                                                   int numVertices,
                                                   int[] indexData,
                                                   int indexOffset,
                                                   int primitiveCount,
                                                   VertexDeclaration vertexDeclaration)

Type Parameters:

T -

Parameters:

primitiveType -

vertexData -

vertexOffset -

numVertices -

indexData -

indexOffset -

primitiveCount -

vertexDeclaration -

DrawUserIndexedPrimitives

public <T extends ValueType & IVertexType> void DrawUserIndexedPrimitives(PrimitiveType primitiveType,
                                                                T[] vertexData,
                                                                int vertexOffset,
                                                                int numVertices,
                                                                short[] indexData,
                                                                int indexOffset,
                                                                int primitiveCount)

Type Parameters:

T -

Parameters:

primitiveType -

vertexData -

vertexOffset -

numVertices -

indexData -

indexOffset -

primitiveCount -

DrawUserIndexedPrimitives

public <T extends ValueType> void DrawUserIndexedPrimitives(PrimitiveType primitiveType,
                                                   T[] vertexData,
                                                   int vertexOffset,
                                                   int numVertices,
                                                   short[] indexData,
                                                   int indexOffset,
                                                   int primitiveCount,
                                                   VertexDeclaration vertexDeclaration)

Type Parameters:

T -

Parameters:

primitiveType -

vertexData -

vertexOffset -

numVertices -

indexData -

indexOffset -

primitiveCount -

vertexDeclaration -

DrawUserPrimitives

public <T extends ValueType & IVertexType> void DrawUserPrimitives(PrimitiveType primitiveType,
                                                         T[] vertexData,
                                                         int vertexOffset,
                                                         int primitiveCount)

Type Parameters:

T -

Parameters:

primitiveType -

vertexData -

vertexOffset -

primitiveCount -

DrawUserPrimitives

public <T extends ValueType> void DrawUserPrimitives(PrimitiveType primitiveType,
                                            T[] vertexData,
                                            int vertexOffset,
                                            int primitiveCount,
                                            VertexDeclaration vertexDeclaration)

Type Parameters:

T -

Parameters:

primitiveType -

vertexData -

vertexOffset -

primitiveCount -

vertexDeclaration -

GetBackBufferData

public <T extends java.lang.Number> void GetBackBufferData(Rectangle rect,
                                                  T[] data,
                                                  int startIndex,
                                                  int offset)

Type Parameters:

T -

Parameters:

rect -

data -

startIndex -

offset -

GetBackBufferData

public <T extends java.lang.Number> void GetBackBufferData(T[] data)

Type Parameters:

T -

Parameters:

data -

GetBackBufferData

public <T extends java.lang.Number> void GetBackBufferData(T[] data,
                                                  int startIndex,
                                                  int elementCount)

Type Parameters:

T -

Parameters:

data -

startIndex -

elementCount -

GetRenderTargets

public RenderTargetBinding[] GetRenderTargets()

Returns:

Present

public void Present()

Reset

public void Reset()

Reset

public void Reset(PresentationParameters presentationParameters)

Parameters:

presentationParameters -

Reset

public void Reset(PresentationParameters presentationParameters,
         GraphicsAdapter adapter)

Parameters:

presentationParameters -

adapter -

SetRenderTarget

public void SetRenderTarget(RenderTarget2D renderTarget)

Sets a new render target for this GraphicsDevice.

Parameters:

renderTarget - A new render target for the device, or null to set the device render target to the back buffer of the device.

SetRenderTarget

public void SetRenderTarget(RenderTargetCube renderTarget,
                   CubeMapFace cubeMapFace)

Parameters:

renderTarget -

cubeMapFace -

SetRenderTargets

public void SetRenderTargets(RenderTargetBinding... renderTargets)

Sets an array of RenderTargets.

Parameters:

renderTargets - An array of RenderTargets.

SetVertexBuffer

public void SetVertexBuffer(VertexBuffer vertexBuffer)

Sets or binds a vertex buffer to the device.

Parameters:

vertexBuffer - A vertex buffer.

SetVertexBuffer

public void SetVertexBuffer(VertexBuffer vertexBuffer,
                   int vertexOffset)

Parameters:

vertexBuffer -

vertexOffset -