Class GlDevice

java.lang.Object

com.mojang.blaze3d.opengl.GlDevice

All Implemented Interfaces:

GpuDeviceBackend, GlDeviceExtension

class GlDevice
extends Object
implements GpuDeviceBackend, GlDeviceExtension

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final record	GlDevice.ShaderCompilationKey

Field Summary

Fields

Modifier and Type	Field	Description
private final BufferStorage	bufferStorage
private final GlDebugLabel	debugLabels
private final @Nullable GlDebug	debugLog
private final ShaderSource	defaultShaderSource
private final DirectStateAccess	directStateAccess
private final Set<String>	enabledExtensions
private final CommandEncoderBackend	encoder
private static final org.slf4j.Logger	LOGGER
private final int	maxSupportedAnisotropy
private final int	maxSupportedTextureSize
private final Map<RenderPipeline, GlRenderPipeline>	pipelineCache
private final Map<GlDevice.ShaderCompilationKey, GlShaderModule>	shaderCache
private final int	uniformOffsetAlignment
protected static boolean	USE_GL_ARB_buffer_storage
protected static boolean	USE_GL_ARB_debug_output
protected static boolean	USE_GL_ARB_direct_state_access
protected static boolean	USE_GL_ARB_vertex_attrib_binding
protected static boolean	USE_GL_EXT_debug_label
protected static boolean	USE_GL_KHR_debug
private final VertexArrayCache	vertexArrayCache
private final long	windowHandle

Constructor Summary

Constructors

Constructor	Description
GlDevice(long windowHandle, ShaderSource defaultShaderSource, GpuDebugOptions debugOptions)

Method Summary

Modifier and Type	Method	Description
void	clearPipelineCache()
void	close()
private GlRenderPipeline	compilePipeline(RenderPipeline pipeline, ShaderSource shaderSource)
private GlProgram	compileProgram(RenderPipeline pipeline, ShaderSource shaderSource)
private GlShaderModule	compileShader(GlDevice.ShaderCompilationKey key, ShaderSource shaderSource)
GpuBuffer	createBuffer(@Nullable Supplier<String> label, int usage, long size)
GpuBuffer	createBuffer(@Nullable Supplier<String> label, int usage, ByteBuffer data)
CommandEncoderBackend	createCommandEncoder()
GpuTexture	createExternalTexture(int usage, @Nullable String label, TextureFormat format, int width, int height, int depthOrLayers, int mipLevels, int nativeId)	Create a new GPU texture from an existing texture whose lifecycle is externally managed.
GpuTexture	createExternalTexture(@Nullable String label, int usage, int nativeId)	Adopt an external OpenGL texture into a GpuTexture.
GpuSampler	createSampler(AddressMode addressModeU, AddressMode addressModeV, FilterMode minFilter, FilterMode magFilter, int maxAnisotropy, OptionalDouble maxLod)
GpuTexture	createTexture(@Nullable String label, int usage, TextureFormat format, int width, int height, int depthOrLayers, int mipLevels)
GpuTexture	createTexture(@Nullable Supplier<String> label, int usage, TextureFormat format, int width, int height, int depthOrLayers, int mipLevels)
GpuTextureView	createTextureView(GpuTexture texture)
GpuTextureView	createTextureView(GpuTexture texture, int baseMipLevel, int mipLevels)
GlDebugLabel	debugLabels()
DirectStateAccess	directStateAccess()
String	getBackendName()
BufferStorage	getBufferStorage()
List<String>	getEnabledExtensions()
String	getImplementationInformation()
List<String>	getLastDebugMessages()
int	getMaxSupportedAnisotropy()
private static int	getMaxSupportedTextureSize()
int	getMaxTextureSize()
protected GlRenderPipeline	getOrCompilePipeline(RenderPipeline pipeline)
protected GlShaderModule	getOrCompileShader(Identifier id, ShaderType type, ShaderDefines defines, ShaderSource shaderSource)
String	getRenderer()
int	getUniformOffsetAlignment()
String	getVendor()
String	getVersion()
boolean	isDebuggingEnabled()
boolean	isZZeroToOne()
GlRenderPipeline	precompilePipeline(RenderPipeline pipeline, @Nullable ShaderSource customShaderSource)
void	presentFrame()
private static void	sacrificeShaderToOpenGlAndAmd()
void	setVsync(boolean enabled)
VertexArrayCache	vertexArrayCache()

Methods inherited from class Object

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

Field Details

LOGGER

private static final org.slf4j.Logger LOGGER

USE_GL_ARB_vertex_attrib_binding

protected static boolean USE_GL_ARB_vertex_attrib_binding

USE_GL_KHR_debug

protected static boolean USE_GL_KHR_debug

USE_GL_EXT_debug_label

protected static boolean USE_GL_EXT_debug_label

USE_GL_ARB_debug_output

protected static boolean USE_GL_ARB_debug_output

USE_GL_ARB_direct_state_access

protected static boolean USE_GL_ARB_direct_state_access

USE_GL_ARB_buffer_storage

protected static boolean USE_GL_ARB_buffer_storage

encoder

private final CommandEncoderBackend encoder

debugLog

private final @Nullable GlDebug debugLog

debugLabels

private final GlDebugLabel debugLabels

maxSupportedTextureSize

private final int maxSupportedTextureSize

directStateAccess

private final DirectStateAccess directStateAccess

defaultShaderSource

private final ShaderSource defaultShaderSource

pipelineCache

private final Map<RenderPipeline, GlRenderPipeline> pipelineCache

shaderCache

private final Map<GlDevice.ShaderCompilationKey, GlShaderModule> shaderCache

vertexArrayCache

private final VertexArrayCache vertexArrayCache

bufferStorage

private final BufferStorage bufferStorage

enabledExtensions

private final Set<String> enabledExtensions

uniformOffsetAlignment

private final int uniformOffsetAlignment

maxSupportedAnisotropy

private final int maxSupportedAnisotropy

windowHandle

private final long windowHandle

Constructor Details

GlDevice

public GlDevice(long windowHandle,
 ShaderSource defaultShaderSource,
 GpuDebugOptions debugOptions)

Method Details

debugLabels

public GlDebugLabel debugLabels()

createCommandEncoder

public CommandEncoderBackend createCommandEncoder()

Specified by:

createCommandEncoder in interface GpuDeviceBackend

getMaxSupportedAnisotropy

public int getMaxSupportedAnisotropy()

Specified by:

getMaxSupportedAnisotropy in interface GpuDeviceBackend

createSampler

public GpuSampler createSampler(AddressMode addressModeU,
 AddressMode addressModeV,
 FilterMode minFilter,
 FilterMode magFilter,
 int maxAnisotropy,
 OptionalDouble maxLod)

Specified by:

createSampler in interface GpuDeviceBackend

createTexture

public GpuTexture createTexture(@Nullable Supplier<String> label,
 int usage,
 TextureFormat format,
 int width,
 int height,
 int depthOrLayers,
 int mipLevels)

Specified by:

createTexture in interface GpuDeviceBackend

createTexture

public GpuTexture createTexture(@Nullable String label,
 int usage,
 TextureFormat format,
 int width,
 int height,
 int depthOrLayers,
 int mipLevels)

Specified by:

createTexture in interface GpuDeviceBackend

createExternalTexture

public GpuTexture createExternalTexture(@Nullable String label,
 int usage,
 int nativeId)

Adopt an external OpenGL texture into a GpuTexture. The lifecycle of the OpenGL texture will not be tied to this GpuTexture and the external system is responsible for cleaning up the OpenGL texture. Calling this is a relatively expensive operation since we introspect the texture using OpenGL getters.

Specified by:

createExternalTexture in interface GlDeviceExtension

createExternalTexture

public GpuTexture createExternalTexture(int usage,
 @Nullable String label,
 TextureFormat format,
 int width,
 int height,
 int depthOrLayers,
 int mipLevels,
 int nativeId)

Create a new GPU texture from an existing texture whose lifecycle is externally managed.

createTextureView

public GpuTextureView createTextureView(GpuTexture texture)

Specified by:

createTextureView in interface GpuDeviceBackend

createTextureView

public GpuTextureView createTextureView(GpuTexture texture,
 int baseMipLevel,
 int mipLevels)

Specified by:

createTextureView in interface GpuDeviceBackend

createBuffer

public GpuBuffer createBuffer(@Nullable Supplier<String> label,
 int usage,
 long size)

Specified by:

createBuffer in interface GpuDeviceBackend

createBuffer

public GpuBuffer createBuffer(@Nullable Supplier<String> label,
 int usage,
 ByteBuffer data)

Specified by:

createBuffer in interface GpuDeviceBackend

getImplementationInformation

public String getImplementationInformation()

Specified by:

getImplementationInformation in interface GpuDeviceBackend

getLastDebugMessages

public List<String> getLastDebugMessages()

Specified by:

getLastDebugMessages in interface GpuDeviceBackend

isDebuggingEnabled

public boolean isDebuggingEnabled()

Specified by:

isDebuggingEnabled in interface GpuDeviceBackend

getRenderer

public String getRenderer()

Specified by:

getRenderer in interface GpuDeviceBackend

getVendor

public String getVendor()

Specified by:

getVendor in interface GpuDeviceBackend

getBackendName

public String getBackendName()

Specified by:

getBackendName in interface GpuDeviceBackend

getVersion

public String getVersion()

Specified by:

getVersion in interface GpuDeviceBackend

getMaxSupportedTextureSize

private static int getMaxSupportedTextureSize()

getMaxTextureSize

public int getMaxTextureSize()

Specified by:

getMaxTextureSize in interface GpuDeviceBackend

getUniformOffsetAlignment

public int getUniformOffsetAlignment()

Specified by:

getUniformOffsetAlignment in interface GpuDeviceBackend

clearPipelineCache

public void clearPipelineCache()

Specified by:

clearPipelineCache in interface GpuDeviceBackend

sacrificeShaderToOpenGlAndAmd

private static void sacrificeShaderToOpenGlAndAmd()

getEnabledExtensions

public List<String> getEnabledExtensions()

Specified by:

getEnabledExtensions in interface GpuDeviceBackend

close

public void close()

Specified by:

close in interface GpuDeviceBackend

setVsync

public void setVsync(boolean enabled)

Specified by:

setVsync in interface GpuDeviceBackend

presentFrame

public void presentFrame()

Specified by:

presentFrame in interface GpuDeviceBackend

isZZeroToOne

public boolean isZZeroToOne()

Specified by:

isZZeroToOne in interface GpuDeviceBackend

directStateAccess

public DirectStateAccess directStateAccess()

getOrCompilePipeline

protected GlRenderPipeline getOrCompilePipeline(RenderPipeline pipeline)

getOrCompileShader

protected GlShaderModule getOrCompileShader(Identifier id,
 ShaderType type,
 ShaderDefines defines,
 ShaderSource shaderSource)

precompilePipeline

public GlRenderPipeline precompilePipeline(RenderPipeline pipeline,
 @Nullable ShaderSource customShaderSource)

Specified by:

precompilePipeline in interface GpuDeviceBackend

compileShader

private GlShaderModule compileShader(GlDevice.ShaderCompilationKey key,
 ShaderSource shaderSource)

compileProgram

private GlProgram compileProgram(RenderPipeline pipeline,
 ShaderSource shaderSource)

compilePipeline

private GlRenderPipeline compilePipeline(RenderPipeline pipeline,
 ShaderSource shaderSource)

vertexArrayCache

public VertexArrayCache vertexArrayCache()

getBufferStorage

public BufferStorage getBufferStorage()