NullRenderer (jMonkeyEngine3)

java.lang.Object
- com.jme3.system.NullRenderer

All Implemented Interfaces:: Renderer

public class NullRenderer
extends java.lang.Object
implements Renderer

Constructor Summary

Constructors
Constructor and Description

NullRenderer()

Constructors
Constructor and Description
`NullRenderer()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applyRenderState(RenderState state)` Applies the given `RenderState`, making the necessary GL calls so that the state is applied.
`void`	`cleanup()` Deletes all previously used `Native Objects` on this Renderer, and then resets the native objects.
`void`	`clearBuffers(boolean color, boolean depth, boolean stencil)` Clears certain channels of the currently bound framebuffer.
`void`	`clearClipRect()` Clears the clipping rectangle set with `Renderer.setClipRect(int, int, int, int)`.
`void`	`copyFrameBuffer(FrameBuffer src, FrameBuffer dst)`
`void`	`copyFrameBuffer(FrameBuffer src, FrameBuffer dst, boolean copyDepth)` Copies contents from src to dst, scaling if necessary.
`void`	`deleteBuffer(BufferObject bo)` Deletes the buffer object from the GPU.
`void`	`deleteBuffer(VertexBuffer vb)` Deletes a vertex buffer from the GPU.
`void`	`deleteFrameBuffer(FrameBuffer fb)` Deletes a framebuffer and all attached renderbuffers
`void`	`deleteImage(Image image)` Deletes a texture from the GPU.
`void`	`deleteShader(Shader shader)` Deletes a shader.
`void`	`deleteShaderSource(Shader.ShaderSource source)` Deletes the provided shader source.
`int[]`	`generateProfilingTasks(int numTasks)` Generates a pool of gpu queries meant to use as profiling tasks
`boolean`	`getAlphaToCoverage()` Gets the alpha to coverage state.
`java.util.EnumSet<Caps>`	`getCaps()` Get the capabilities of the renderer.
`int`	`getDefaultAnisotropicFilter()` Get the default anisotropic filter level for textures.
`java.util.EnumMap<Limits,java.lang.Integer>`	`getLimits()` Get the limits of the renderer.
`long`	`getProfilingTime(int taskId)` Returns the time in nano seconds elapsed for the task with the given id.
`Statistics`	`getStatistics()` The statistics allow tracking of how data per frame, such as number of objects rendered, number of triangles, etc.
`void`	`initialize()` Detects available capabilities of the GPU.
`void`	`invalidateState()` Invalidates the current rendering state.
`boolean`	`isTaskResultAvailable(int taskId)` Check if the profiling results are available
`void`	`modifyTexture(Texture tex, Image pixels, int x, int y)` Modify the given Texture with the given Image.
`void`	`postFrame()` Called when a new frame has been rendered.
`void`	`readFrameBuffer(FrameBuffer fb, java.nio.ByteBuffer byteBuf)` Reads the pixels currently stored in the specified framebuffer into the given ByteBuffer object.
`void`	`readFrameBufferWithFormat(FrameBuffer fb, java.nio.ByteBuffer byteBuf, Image.Format format)` Reads the pixels currently stored in the specified framebuffer into the given ByteBuffer object.
`void`	`renderMesh(Mesh mesh, int lod, int count, VertexBuffer[] instanceData)` Renders `count` meshes, with the geometry data supplied and per-instance data supplied.
`void`	`resetGLObjects()` Resets all previously used `Native Objects` on this Renderer.
`void`	`setAlphaToCoverage(boolean value)` Sets the alpha to coverage state.
`void`	`setBackgroundColor(ColorRGBA color)` Sets the background (aka clear) color.
`void`	`setClipRect(int x, int y, int width, int height)` Specifies a clipping rectangle.
`void`	`setDefaultAnisotropicFilter(int level)` Set the default anisotropic filter level for textures.
`void`	`setDepthRange(float start, float end)` Set the range of the depth values for objects.
`void`	`setFrameBuffer(FrameBuffer fb)` Sets the framebuffer that will be drawn to.
`void`	`setLighting(LightList lights)`
`void`	`setLinearizeSrgbImages(boolean linearize)` If enabled, all `images` with the `sRGB flag` set shall undergo an sRGB to linear RGB color conversion when read by a shader.
`void`	`setMainFrameBufferOverride(FrameBuffer fb)` Set the framebuffer that will be set instead of the main framebuffer when a call to setFrameBuffer(null) is made.
`void`	`setMainFrameBufferSrgb(boolean srgb)` If enabled, color values rendered to the main framebuffer undergo linear -> sRGB conversion.
`void`	`setShader(Shader shader)` Sets the shader to use for rendering.
`void`	`setTexture(int unit, Texture tex)` Sets the texture to use for the given texture unit.
`void`	`setViewPort(int x, int y, int width, int height)` Set the viewport location and resolution on the screen.
`void`	`setViewProjectionMatrices(Matrix4f viewMatrix, Matrix4f projMatrix)`
`void`	`setWorldMatrix(Matrix4f worldMatrix)`
`void`	`startProfiling(int id)` Starts a time profiling task on the GPU.
`void`	`stopProfiling()` Will stop the last profiling task started with startProfiling
`void`	`updateBufferData(BufferObject bo)` Uploads data of the buffer object on the GPU.
`void`	`updateBufferData(VertexBuffer vb)` Uploads a vertex buffer to the GPU.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - NullRenderer
```
public NullRenderer()
```
- Method Detail
  - initialize
```
public void initialize()
```
    Description copied from interface: Renderer
    
    Detects available capabilities of the GPU. Must be called prior to any other Renderer methods.
    
    Specified by:
    
    initialize in interface Renderer
  - getLimits
```
public java.util.EnumMap<Limits,java.lang.Integer> getLimits()
```
    Description copied from interface: Renderer
    
    Get the limits of the renderer.
    
    Specified by:
    
    getLimits in interface Renderer
    
    Returns:
    
    The limits of the renderer.
  - getCaps
```
public java.util.EnumSet<Caps> getCaps()
```
    Description copied from interface: Renderer
    
    Get the capabilities of the renderer.
    
    Specified by:
    
    getCaps in interface Renderer
    
    Returns:
    
    The capabilities of the renderer.
  - getStatistics
```
public Statistics getStatistics()
```
    Description copied from interface: Renderer
    
    The statistics allow tracking of how data per frame, such as number of objects rendered, number of triangles, etc. These are updated when the Renderer's methods are used, make sure to call Statistics.clearFrame() at the appropriate time to get accurate info per frame.
    
    Specified by:
    
    getStatistics in interface Renderer
  - invalidateState
```
public void invalidateState()
```
    Description copied from interface: Renderer
    
    Invalidates the current rendering state. Should be called after the GL state was changed manually or through an external library.
    
    Specified by:
    
    invalidateState in interface Renderer
  - clearBuffers
```
public void clearBuffers(boolean color,
                         boolean depth,
                         boolean stencil)
```
    Description copied from interface: Renderer
    
    Clears certain channels of the currently bound framebuffer.
    
    Specified by:
    
    clearBuffers in interface Renderer
    
    Parameters:
    
    color - True if to clear colors (RGBA)
    
    depth - True if to clear depth/z
    
    stencil - True if to clear stencil buffer (if available, otherwise ignored)
  - setBackgroundColor
```
public void setBackgroundColor(ColorRGBA color)
```
    Description copied from interface: Renderer
    
    Sets the background (aka clear) color.
    
    Specified by:
    
    setBackgroundColor in interface Renderer
    
    Parameters:
    
    color - The background color to set
  - applyRenderState
```
public void applyRenderState(RenderState state)
```
    Description copied from interface: Renderer
    
    Applies the given RenderState, making the necessary GL calls so that the state is applied.
    
    Specified by:
    
    applyRenderState in interface Renderer
  - setDepthRange
```
public void setDepthRange(float start,
                          float end)
```
    Description copied from interface: Renderer
    
    Set the range of the depth values for objects. All rendered objects will have their depth clamped to this range.
    
    Specified by:
    
    setDepthRange in interface Renderer
    
    Parameters:
    
    start - The range start
    
    end - The range end
  - postFrame
```
public void postFrame()
```
    Description copied from interface: Renderer
    
    Called when a new frame has been rendered. Currently, this will simply delete any OpenGL objects from the GPU which have been garbage collected by the GC.
    
    Specified by:
    
    postFrame in interface Renderer
  - setWorldMatrix
```
public void setWorldMatrix(Matrix4f worldMatrix)
```
  - setViewProjectionMatrices
```
public void setViewProjectionMatrices(Matrix4f viewMatrix,
                                      Matrix4f projMatrix)
```
  - setViewPort
```
public void setViewPort(int x,
                        int y,
                        int width,
                        int height)
```
    Description copied from interface: Renderer
    
    Set the viewport location and resolution on the screen.
    
    Specified by:
    
    setViewPort in interface Renderer
    
    Parameters:
    
    x - The x coordinate of the viewport
    
    y - The y coordinate of the viewport
    
    width - Width of the viewport
    
    height - Height of the viewport
  - setClipRect
```
public void setClipRect(int x,
                        int y,
                        int width,
                        int height)
```
    Description copied from interface: Renderer
    
    Specifies a clipping rectangle. For all future rendering commands, no pixels will be allowed to be rendered outside of the clip rectangle.
    
    Specified by:
    
    setClipRect in interface Renderer
    
    Parameters:
    
    x - The x coordinate of the clip rect
    
    y - The y coordinate of the clip rect
    
    width - Width of the clip rect
    
    height - Height of the clip rect
  - clearClipRect
```
public void clearClipRect()
```
    Description copied from interface: Renderer
    
    Clears the clipping rectangle set with Renderer.setClipRect(int, int, int, int).
    
    Specified by:
    
    clearClipRect in interface Renderer
  - setLighting
```
public void setLighting(LightList lights)
```
  - setShader
```
public void setShader(Shader shader)
```
    Description copied from interface: Renderer
    
    Sets the shader to use for rendering. If the shader has not been uploaded yet, it is compiled and linked. If it has been uploaded, then the uniform data is updated and the shader is set.
    
    Specified by:
    
    setShader in interface Renderer
    
    Parameters:
    
    shader - The shader to use for rendering.
  - deleteShader
```
public void deleteShader(Shader shader)
```
    Description copied from interface: Renderer
    
    Deletes a shader. This method also deletes the attached shader sources.
    
    Specified by:
    
    deleteShader in interface Renderer
    
    Parameters:
    
    shader - Shader to delete.
    
    See Also:
    
    Renderer.deleteShaderSource(com.jme3.shader.Shader.ShaderSource)
  - deleteShaderSource
```
public void deleteShaderSource(Shader.ShaderSource source)
```
    Description copied from interface: Renderer
    
    Deletes the provided shader source.
    
    Specified by:
    
    deleteShaderSource in interface Renderer
    
    Parameters:
    
    source - The ShaderSource to delete.
  - copyFrameBuffer
```
public void copyFrameBuffer(FrameBuffer src,
                            FrameBuffer dst)
```
  - copyFrameBuffer
```
public void copyFrameBuffer(FrameBuffer src,
                            FrameBuffer dst,
                            boolean copyDepth)
```
    Description copied from interface: Renderer
    
    Copies contents from src to dst, scaling if necessary. set copyDepth to false to only copy the color buffers.
    
    Specified by:
    
    copyFrameBuffer in interface Renderer
  - setMainFrameBufferOverride
```
public void setMainFrameBufferOverride(FrameBuffer fb)
```
    Description copied from interface: Renderer
    
    Set the framebuffer that will be set instead of the main framebuffer when a call to setFrameBuffer(null) is made.
    
    Specified by:
    
    setMainFrameBufferOverride in interface Renderer
    
    Parameters:
    
    fb - The framebuffer to override the main framebuffer.
  - setFrameBuffer
```
public void setFrameBuffer(FrameBuffer fb)
```
    Description copied from interface: Renderer
    
    Sets the framebuffer that will be drawn to. If the framebuffer has not been initialized yet, it will be created and its render surfaces and attached textures will be allocated.
    
    Specified by:
    
    setFrameBuffer in interface Renderer
    
    Parameters:
    
    fb - The framebuffer to set
  - readFrameBuffer
```
public void readFrameBuffer(FrameBuffer fb,
                            java.nio.ByteBuffer byteBuf)
```
    Description copied from interface: Renderer
    
    Reads the pixels currently stored in the specified framebuffer into the given ByteBuffer object. Only color pixels are transferred, the format is RGBA with 8 bits per component. The given byte buffer should have at least fb.getWidth() * fb.getHeight() * 4 bytes remaining.
    
    Specified by:
    
    readFrameBuffer in interface Renderer
    
    Parameters:
    
    fb - The framebuffer to read from
    
    byteBuf - The bytebuffer to transfer color data to
  - deleteFrameBuffer
```
public void deleteFrameBuffer(FrameBuffer fb)
```
    Description copied from interface: Renderer
    
    Deletes a framebuffer and all attached renderbuffers
    
    Specified by:
    
    deleteFrameBuffer in interface Renderer
  - setTexture
```
public void setTexture(int unit,
                       Texture tex)
```
    Description copied from interface: Renderer
    
    Sets the texture to use for the given texture unit.
    
    Specified by:
    
    setTexture in interface Renderer
  - modifyTexture
```
public void modifyTexture(Texture tex,
                          Image pixels,
                          int x,
                          int y)
```
    Description copied from interface: Renderer
    
    Modify the given Texture with the given Image. The image will be put at x and y into the texture. NOTE: this is only supported for uncompressed 2D images without mipmaps.
    
    Specified by:
    
    modifyTexture in interface Renderer
    
    Parameters:
    
    tex - the Texture that will be modified
    
    pixels - the source Image data to copy data from
    
    x - the x position to put the image into the texture
    
    y - the y position to put the image into the texture
  - updateBufferData
```
public void updateBufferData(VertexBuffer vb)
```
    Description copied from interface: Renderer
    
    Uploads a vertex buffer to the GPU.
    
    Specified by:
    
    updateBufferData in interface Renderer
    
    Parameters:
    
    vb - The vertex buffer to upload
  - updateBufferData
```
public void updateBufferData(BufferObject bo)
```
    Description copied from interface: Renderer
    
    Uploads data of the buffer object on the GPU.
    
    Specified by:
    
    updateBufferData in interface Renderer
    
    Parameters:
    
    bo - the buffer object to upload.
  - deleteBuffer
```
public void deleteBuffer(VertexBuffer vb)
```
    Description copied from interface: Renderer
    
    Deletes a vertex buffer from the GPU.
    
    Specified by:
    
    deleteBuffer in interface Renderer
    
    Parameters:
    
    vb - The vertex buffer to delete
  - deleteBuffer
```
public void deleteBuffer(BufferObject bo)
```
    Description copied from interface: Renderer
    
    Deletes the buffer object from the GPU.
    
    Specified by:
    
    deleteBuffer in interface Renderer
    
    Parameters:
    
    bo - the buffer object to delete.
  - renderMesh
```
public void renderMesh(Mesh mesh,
                       int lod,
                       int count,
                       VertexBuffer[] instanceData)
```
    Description copied from interface: Renderer
    
    Renders count meshes, with the geometry data supplied and per-instance data supplied. The shader which is currently set with setShader is responsible for transforming the input vertices into clip space and shading it based on the given vertex attributes. The integer variable gl_InstanceID can be used to access the current instance of the mesh being rendered inside the vertex shader. If the instance data is non-null, then it is submitted as a per-instance vertex attribute to the shader.
    
    Specified by:
    
    renderMesh in interface Renderer
    
    Parameters:
    
    mesh - The mesh to render
    
    lod - The LOD level to use, see Mesh.setLodLevels(com.jme3.scene.VertexBuffer[]).
    
    count - Number of mesh instances to render
    
    instanceData - When count is greater than 1, these buffers provide the per-instance attributes.
  - resetGLObjects
```
public void resetGLObjects()
```
    Description copied from interface: Renderer
    
    Resets all previously used Native Objects on this Renderer. The state of the native objects is reset in such way, that using them again will cause the renderer to reupload them. Call this method when you know the GL context is going to shutdown.
    
    Specified by:
    
    resetGLObjects in interface Renderer
    
    See Also:
    
    NativeObject.resetObject()
  - cleanup
```
public void cleanup()
```
    Description copied from interface: Renderer
    
    Deletes all previously used Native Objects on this Renderer, and then resets the native objects.
    
    Specified by:
    
    cleanup in interface Renderer
    
    See Also:
    
    Renderer.resetGLObjects(), NativeObject.deleteObject(java.lang.Object)
  - deleteImage
```
public void deleteImage(Image image)
```
    Description copied from interface: Renderer
    
    Deletes a texture from the GPU.
    
    Specified by:
    
    deleteImage in interface Renderer
  - setAlphaToCoverage
```
public void setAlphaToCoverage(boolean value)
```
    Description copied from interface: Renderer
    
    Sets the alpha to coverage state.
    When alpha coverage and multi-sampling is enabled, each pixel will contain alpha coverage in all of its subsamples, which is then combined when other future alpha-blended objects are rendered.
    
    Alpha-to-coverage is useful for rendering transparent objects without having to worry about sorting them.
    
    Specified by:
    
    setAlphaToCoverage in interface Renderer
  - setMainFrameBufferSrgb
```
public void setMainFrameBufferSrgb(boolean srgb)
```
    Description copied from interface: Renderer
    
    If enabled, color values rendered to the main framebuffer undergo linear -> sRGB conversion. This is identical to FrameBuffer.setSrgb(boolean) except it is toggled for the main framebuffer instead of an offscreen buffer. This should be set together with Renderer.setLinearizeSrgbImages(boolean) As a shorthand, the user can set AppSettings.setGammaCorrection(boolean) to true to toggle both Renderer.setLinearizeSrgbImages(boolean) and Renderer.setMainFrameBufferSrgb(boolean) if the Caps.Srgb is supported by the GPU.
    
    Specified by:
    
    setMainFrameBufferSrgb in interface Renderer
    
    See Also:
    
    FrameBuffer.setSrgb(boolean), Caps.Srgb
  - setLinearizeSrgbImages
```
public void setLinearizeSrgbImages(boolean linearize)
```
    Description copied from interface: Renderer
    
    If enabled, all images with the sRGB flag set shall undergo an sRGB to linear RGB color conversion when read by a shader. The conversion is performed for the following formats: - Image.Format.RGB8 - Image.Format.RGBA8 - Image.Format.Luminance8 - Image.Format.Luminance8Alpha8 - Image.Format.DXT1 - Image.Format.DXT1A - Image.Format.DXT3 - Image.Format.DXT5 For all other formats, no conversion is performed. If this option is toggled at runtime, textures must be reloaded for the change to take effect.
    
    Specified by:
    
    setLinearizeSrgbImages in interface Renderer
    
    Parameters:
    
    linearize - If sRGB images undergo sRGB -> linear conversion prior to rendering.
    
    See Also:
    
    Caps.Srgb
  - generateProfilingTasks
```
public int[] generateProfilingTasks(int numTasks)
```
    Description copied from interface: Renderer
    
    Generates a pool of gpu queries meant to use as profiling tasks
    
    Specified by:
    
    generateProfilingTasks in interface Renderer
    
    Parameters:
    
    numTasks - the number of task ids to generate
    
    Returns:
    
    an array of tasks ids.
  - startProfiling
```
public void startProfiling(int id)
```
    Description copied from interface: Renderer
    
    Starts a time profiling task on the GPU. This will profile all operations called between startProfiling and stopProfiling
    
    Specified by:
    
    startProfiling in interface Renderer
    
    Parameters:
    
    id - the id of the task to start profiling.
  - stopProfiling
```
public void stopProfiling()
```
    Description copied from interface: Renderer
    
    Will stop the last profiling task started with startProfiling
    
    Specified by:
    
    stopProfiling in interface Renderer
  - getProfilingTime
```
public long getProfilingTime(int taskId)
```
    Description copied from interface: Renderer
    
    Returns the time in nano seconds elapsed for the task with the given id. Note that the result may not be available right after stopProfiling has been called. You need to check if the result is available with isTaskResultAvailable. Also note that it's guaranteed that the result will be available on next frame. If you use getProfilingTime on the next frame you called stopProfiling, you don't need to check the result availability with isTaskResultAvailable
    
    Specified by:
    
    getProfilingTime in interface Renderer
    
    Parameters:
    
    taskId - the id of the task given by startProfiling.
    
    Returns:
    
    the time in nano second of the profiling task with the given id.
  - isTaskResultAvailable
```
public boolean isTaskResultAvailable(int taskId)
```
    Description copied from interface: Renderer
    
    Check if the profiling results are available
    
    Specified by:
    
    isTaskResultAvailable in interface Renderer
    
    Parameters:
    
    taskId - the id of the task provided by startProfiling
    
    Returns:
    
    true if the results of the task with the given task id are available.
  - readFrameBufferWithFormat
```
public void readFrameBufferWithFormat(FrameBuffer fb,
                                      java.nio.ByteBuffer byteBuf,
                                      Image.Format format)
```
    Description copied from interface: Renderer
    
    Reads the pixels currently stored in the specified framebuffer into the given ByteBuffer object. Only color pixels are transferred, with the given format. The given byte buffer should have at least fb.getWidth() * fb.getHeight() * 4 bytes remaining.
    
    Specified by:
    
    readFrameBufferWithFormat in interface Renderer
    
    Parameters:
    
    fb - The framebuffer to read from
    
    byteBuf - The bytebuffer to transfer color data to
    
    format - the image format to use when reading the frameBuffer.
  - setDefaultAnisotropicFilter
```
public void setDefaultAnisotropicFilter(int level)
```
    Description copied from interface: Renderer
    
    Set the default anisotropic filter level for textures. If the texture anisotropic filter is set to 0, then the default level is used. Otherwise if the texture level is 1 or greater, then the texture's value overrides the default value.
    
    Specified by:
    
    setDefaultAnisotropicFilter in interface Renderer
    
    Parameters:
    
    level - The default anisotropic filter level to use. Default: 1.
  - getAlphaToCoverage
```
public boolean getAlphaToCoverage()
```
    Description copied from interface: Renderer
    
    Gets the alpha to coverage state.
    
    Specified by:
    
    getAlphaToCoverage in interface Renderer
  - getDefaultAnisotropicFilter
```
public int getDefaultAnisotropicFilter()
```
    Description copied from interface: Renderer
    
    Get the default anisotropic filter level for textures.
    
    Specified by:
    
    getDefaultAnisotropicFilter in interface Renderer

Class NullRenderer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NullRenderer

Method Detail

initialize

getLimits

getCaps

getStatistics

invalidateState

clearBuffers

setBackgroundColor

applyRenderState

setDepthRange

postFrame

setWorldMatrix

setViewProjectionMatrices

setViewPort

setClipRect

clearClipRect

setLighting

setShader

deleteShader

deleteShaderSource

copyFrameBuffer

copyFrameBuffer

setMainFrameBufferOverride

setFrameBuffer

readFrameBuffer

deleteFrameBuffer

setTexture

modifyTexture

updateBufferData

updateBufferData

deleteBuffer

deleteBuffer

renderMesh

resetGLObjects

cleanup

deleteImage

setAlphaToCoverage

setMainFrameBufferSrgb

setLinearizeSrgbImages

generateProfilingTasks

startProfiling

stopProfiling

getProfilingTime

isTaskResultAvailable

readFrameBufferWithFormat

setDefaultAnisotropicFilter

getAlphaToCoverage

getDefaultAnisotropicFilter