com.jme3.system

Enum JmeContext.Type

java.lang.Object

java.lang.Enum<JmeContext.Type>

com.jme3.system.JmeContext.Type

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<JmeContext.Type>

Enclosing interface:

JmeContext

public static enum JmeContext.Type
extends java.lang.Enum<JmeContext.Type>

The type of context.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Canvas A canvas type context makes a rendering surface available as an AWT Canvas object that can be embedded in a Swing/AWT frame.
Display A display can represent a windowed or a fullscreen-exclusive display.
Headless A Headless context is not visible and does not have any drawable surface.
OffscreenSurface An OffscreenSurface is a context that is not visible by the user.

Method Summary

Modifier and Type	Method and Description
static JmeContext.Type	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static JmeContext.Type[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Display

public static final JmeContext.Type Display

A display can represent a windowed or a fullscreen-exclusive display. If windowed, the graphics are rendered to a new on-screen surface enclosed in a window defined by the operating system. Implementations are encouraged to not use AWT or Swing to create the OpenGL display but rather use native operating system functions to set up a native display with the windowing system.

Canvas

public static final JmeContext.Type Canvas

A canvas type context makes a rendering surface available as an AWT Canvas object that can be embedded in a Swing/AWT frame. To retrieve the Canvas object, you should cast the context to JmeCanvasContext.

OffscreenSurface

public static final JmeContext.Type OffscreenSurface

An OffscreenSurface is a context that is not visible by the user. The application can use the offscreen surface to do General Purpose GPU computations or render a scene into a buffer in order to save it as a screenshot, video or send through a network.

Headless

public static final JmeContext.Type Headless

A Headless context is not visible and does not have any drawable surface. The implementation does not provide any display, input, or sound support.

Method Detail

values

public static JmeContext.Type[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (JmeContext.Type c : JmeContext.Type.values())
    System.out.println(c);

Returns:

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

valueOf

public static JmeContext.Type valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null