Package net.neoforged.neoforge.client.blaze3d.validation

Class ValidationGpuDevice

java.lang.Object

net.neoforged.neoforge.client.blaze3d.validation.ValidationGpuDevice

All Implemented Interfaces:

GpuDevice, GpuDeviceExtension

public class ValidationGpuDevice
extends Object
implements GpuDevice

The validation GpuDevice is used to ensure that both mods and backends are complying with the B3D API contract correctly.

Validation done by this class includes:

• Known texture/buffer usage bits
• Known NonExhaustiveEnum values
• Validates RenderPipeline precompilation

Field Summary

Fields

Modifier and Type	Field	Description
protected final GpuDevice	realDevice
private final ValidationCommandEncoder	validationCommandEncoder
protected final GpuDeviceUsageValidator	validator

Constructor Summary

Constructors

Constructor	Description
ValidationGpuDevice(GpuDevice realDevice, boolean checkReservedUsageBits)

Method Summary

Modifier and Type	Method	Description
void	clearPipelineCache()
void	close()
GpuBuffer	createBuffer(@Nullable Supplier<String> label, int usage, int size)
GpuBuffer	createBuffer(@Nullable Supplier<String> label, int usage, ByteBuffer data)
CommandEncoder	createCommandEncoder()
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)
GpuDeviceProperties	deviceProperties()
GpuDeviceFeatures	enabledFeatures()	GpuDeviceFeatures enabled during device configuration.
String	getBackendName()
List<String>	getEnabledExtensions()
String	getImplementationInformation()
List<String>	getLastDebugMessages()
int	getMaxTextureSize()
GpuDevice	getRealDevice()
String	getRenderer()
int	getUniformOffsetAlignment()
String	getVendor()
String	getVersion()
boolean	isDebuggingEnabled()
CompiledRenderPipeline	precompilePipeline(RenderPipeline pipeline, @Nullable BiFunction<ResourceLocation,ShaderType,String> shaderSourceProvider)
protected ValidationCommandEncoder	wrapCommandEncoder(CommandEncoder commandEncoder, GpuDeviceUsageValidator validator)
protected ValidationGpuTexture	wrapGpuTexture(GpuTexture texture, GpuDeviceUsageValidator validator)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.mojang.blaze3d.systems.GpuDevice

precompilePipeline

Field Details

realDevice

protected final GpuDevice realDevice

validator

protected final GpuDeviceUsageValidator validator

validationCommandEncoder

private final ValidationCommandEncoder validationCommandEncoder

Constructor Details

ValidationGpuDevice

public ValidationGpuDevice(GpuDevice realDevice,
 boolean checkReservedUsageBits)

Method Details

getRealDevice

@Internal
public GpuDevice getRealDevice()

wrapCommandEncoder

protected ValidationCommandEncoder wrapCommandEncoder(CommandEncoder commandEncoder,
 GpuDeviceUsageValidator validator)

createCommandEncoder

public CommandEncoder createCommandEncoder()

Specified by:

createCommandEncoder in interface GpuDevice

wrapGpuTexture

protected ValidationGpuTexture wrapGpuTexture(GpuTexture texture,
 GpuDeviceUsageValidator validator)

createTexture

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

Specified by:

createTexture in interface GpuDevice

createTexture

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

Specified by:

createTexture in interface GpuDevice

createTextureView

public GpuTextureView createTextureView(GpuTexture texture)

Specified by:

createTextureView in interface GpuDevice

createTextureView

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

Specified by:

createTextureView in interface GpuDevice

createBuffer

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

Specified by:

createBuffer in interface GpuDevice

createBuffer

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

Specified by:

createBuffer in interface GpuDevice

getImplementationInformation

public String getImplementationInformation()

Specified by:

getImplementationInformation in interface GpuDevice

getLastDebugMessages

public List<String> getLastDebugMessages()

Specified by:

getLastDebugMessages in interface GpuDevice

isDebuggingEnabled

public boolean isDebuggingEnabled()

Specified by:

isDebuggingEnabled in interface GpuDevice

getVendor

public String getVendor()

Specified by:

getVendor in interface GpuDevice

getBackendName

public String getBackendName()

Specified by:

getBackendName in interface GpuDevice

getVersion

public String getVersion()

Specified by:

getVersion in interface GpuDevice

getRenderer

public String getRenderer()

Specified by:

getRenderer in interface GpuDevice

getMaxTextureSize

public int getMaxTextureSize()

Specified by:

getMaxTextureSize in interface GpuDevice

getUniformOffsetAlignment

public int getUniformOffsetAlignment()

Specified by:

getUniformOffsetAlignment in interface GpuDevice

precompilePipeline

public CompiledRenderPipeline precompilePipeline(RenderPipeline pipeline,
 @Nullable
 @Nullable BiFunction<ResourceLocation,ShaderType,String> shaderSourceProvider)

Specified by:

precompilePipeline in interface GpuDevice

clearPipelineCache

public void clearPipelineCache()

Specified by:

clearPipelineCache in interface GpuDevice

getEnabledExtensions

public List<String> getEnabledExtensions()

Specified by:

getEnabledExtensions in interface GpuDevice

close

public void close()

Specified by:

close in interface GpuDevice

deviceProperties

public GpuDeviceProperties deviceProperties()

Specified by:

deviceProperties in interface GpuDeviceExtension

See Also:

• GpuDeviceProperties

enabledFeatures

public GpuDeviceFeatures enabledFeatures()

Description copied from interface: GpuDeviceExtension

GpuDeviceFeatures enabled during device configuration.

Specified by:

enabledFeatures in interface GpuDeviceExtension

See Also:

• GpuDeviceFeatures
• ConfigureGpuDeviceEvent