Package com.ardor3d.renderer

Enum Class TextureRendererFactory

java.lang.Object

java.lang.Enum<TextureRendererFactory>

com.ardor3d.renderer.TextureRendererFactory

All Implemented Interfaces:

Serializable, Comparable<TextureRendererFactory>, Constable

public enum TextureRendererFactory
extends Enum<TextureRendererFactory>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE

Method Summary

Modifier and Type	Method	Description
TextureRenderer	createTextureRenderer(int width, int height, int depthBits, int samples, Renderer renderer, ContextCapabilities caps)	Create a TextureRenderer using params that are meaningful regardless of whether a Pbuffer or FBO renderer are used.
TextureRenderer	createTextureRenderer(int width, int height, Renderer renderer, ContextCapabilities caps)	Create a TextureRenderer of the given width and height.
TextureRenderer	createTextureRenderer(DisplaySettings settings, boolean forcePbuffer, Renderer renderer, ContextCapabilities caps)	Create a TextureRenderer using as many of the given DisplaySettings that are meaningful for the chosen type.
void	setProvider(TextureRendererProvider provider)
static TextureRendererFactory	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TextureRendererFactory[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INSTANCE

public static final TextureRendererFactory INSTANCE

Method Details

values

public static TextureRendererFactory[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static TextureRendererFactory valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

setProvider

public void setProvider(TextureRendererProvider provider)

createTextureRenderer

public TextureRenderer createTextureRenderer(int width,
 int height,
 Renderer renderer,
 ContextCapabilities caps)

Create a TextureRenderer of the given width and height. All other params are considered undefined. We will attempt to make an FBO based renderer if supported, or a Pbuffer based renderer if supported, or null if neither are supported.

Parameters:

width - the width of our off screen rendering target

height - the height of our off screen rendering target

renderer - the renderer to use when rendering to this off screen target.

caps - the context capabilities, used for testing.

Returns:

a TextureRenderer

Throws:

IllegalStateException - if provider has not been set prior to calling this method.

createTextureRenderer

public TextureRenderer createTextureRenderer(int width,
 int height,
 int depthBits,
 int samples,
 Renderer renderer,
 ContextCapabilities caps)

Create a TextureRenderer using params that are meaningful regardless of whether a Pbuffer or FBO renderer are used. We will attempt to make an FBO based renderer if supported, or a Pbuffer based renderer if supported, or null if neither are supported.

Parameters:

width - the width of our off screen rendering target

height - the height of our off screen rendering target

depthBits - the desired depth buffer size of our off screen rendering target

samples - the number of samples for our off screen rendering target

renderer - the renderer to use when rendering to this off screen target.

caps - the context capabilities, used for testing.

Returns:

a TextureRenderer

Throws:

IllegalStateException - if provider has not been set prior to calling this method.

createTextureRenderer

public TextureRenderer createTextureRenderer(DisplaySettings settings,
 boolean forcePbuffer,
 Renderer renderer,
 ContextCapabilities caps)

Create a TextureRenderer using as many of the given DisplaySettings that are meaningful for the chosen type. Unless forcePbuffer is true, we will attempt to make an FBO based renderer if supported, or a Pbuffer based renderer if supported, or null if neither are supported.

Parameters:

settings - a complete set of possible display settings to use. Some will only be valid if Pbuffer is used.

forcePbuffer - if true, we will return a pbuffer or null if pbuffers are not supported.

renderer - the renderer to use when rendering to this off screen target.

caps - the context capabilities, used for testing.

Returns:

a TextureRenderer

Throws:

IllegalStateException - if provider has not been set prior to calling this method.