Interface RenderDevice

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

GlRenderDevice, HeadlessRenderDevice, VkRenderDevice, WgpuRenderDevice

public interface RenderDevice
extends AutoCloseable

Low-level backend interface for GPU resource management and command execution. Users should not use this directly — use Renderer from graphics:common instead.

Method Summary

Modifier and Type	Method	Description
void	beginFrame()
void	close()
Handle<BufferResource>	createBuffer(BufferDescriptor descriptor)
default Handle<PipelineResource>	createComputePipeline(ComputePipelineDescriptor descriptor)
GpuFence	createFence()
Handle<PipelineResource>	createPipeline(PipelineDescriptor descriptor)
Handle<RenderTargetResource>	createRenderTarget(RenderTargetDescriptor descriptor)
Handle<SamplerResource>	createSampler(SamplerDescriptor descriptor)
StreamingBuffer	createStreamingBuffer(long frameSize, int frameCount, BufferUsage usage)
Handle<TextureResource>	createTexture(TextureDescriptor descriptor)
Handle<VertexInputResource>	createVertexInput(VertexFormat format)
void	destroyBuffer(Handle<BufferResource> buffer)
void	destroyPipeline(Handle<PipelineResource> pipeline)
void	destroyRenderTarget(Handle<RenderTargetResource> renderTarget)
void	destroySampler(Handle<SamplerResource> sampler)
void	destroyTexture(Handle<TextureResource> texture)
void	destroyVertexInput(Handle<VertexInputResource> vertexInput)
void	endFrame()
long	getBindlessTextureHandle(Handle<TextureResource> texture)
Handle<TextureResource>	getRenderTargetColorTexture(Handle<RenderTargetResource> renderTarget, int index)
default int	getTextureIndex(Handle<TextureResource> texture)	Returns an integer index for the given texture, usable in shaders for bindless access.
boolean	isValidBuffer(Handle<BufferResource> buffer)
boolean	isValidPipeline(Handle<PipelineResource> pipeline)
boolean	isValidTexture(Handle<TextureResource> texture)
<T> T	queryCapability(DeviceCapability<T> capability)
default byte[]	readFramebuffer(int width, int height)	Reads back the current framebuffer as RGBA8 byte array.
void	submit(CommandList commands)
default boolean	supports(DeviceCapability<Boolean> feature)
void	uploadTexture(Handle<TextureResource> texture, ByteBuffer pixels)
BufferWriter	writeBuffer(Handle<BufferResource> buffer)
BufferWriter	writeBuffer(Handle<BufferResource> buffer, long offset, long length)

Method Details

createBuffer

Handle<BufferResource> createBuffer(BufferDescriptor descriptor)

destroyBuffer

void destroyBuffer(Handle<BufferResource> buffer)

isValidBuffer

boolean isValidBuffer(Handle<BufferResource> buffer)

writeBuffer

BufferWriter writeBuffer(Handle<BufferResource> buffer)

writeBuffer

BufferWriter writeBuffer(Handle<BufferResource> buffer,
 long offset,
 long length)

createTexture

Handle<TextureResource> createTexture(TextureDescriptor descriptor)

uploadTexture

void uploadTexture(Handle<TextureResource> texture,
 ByteBuffer pixels)

destroyTexture

void destroyTexture(Handle<TextureResource> texture)

isValidTexture

boolean isValidTexture(Handle<TextureResource> texture)

createRenderTarget

Handle<RenderTargetResource> createRenderTarget(RenderTargetDescriptor descriptor)

getRenderTargetColorTexture

Handle<TextureResource> getRenderTargetColorTexture(Handle<RenderTargetResource> renderTarget,
 int index)

destroyRenderTarget

void destroyRenderTarget(Handle<RenderTargetResource> renderTarget)

createVertexInput

Handle<VertexInputResource> createVertexInput(VertexFormat format)

destroyVertexInput

void destroyVertexInput(Handle<VertexInputResource> vertexInput)

createSampler

Handle<SamplerResource> createSampler(SamplerDescriptor descriptor)

destroySampler

void destroySampler(Handle<SamplerResource> sampler)

createPipeline

Handle<PipelineResource> createPipeline(PipelineDescriptor descriptor)

destroyPipeline

void destroyPipeline(Handle<PipelineResource> pipeline)

isValidPipeline

boolean isValidPipeline(Handle<PipelineResource> pipeline)

createComputePipeline

default Handle<PipelineResource> createComputePipeline(ComputePipelineDescriptor descriptor)

beginFrame

void beginFrame()

endFrame

void endFrame()

submit

void submit(CommandList commands)

createStreamingBuffer

StreamingBuffer createStreamingBuffer(long frameSize,
 int frameCount,
 BufferUsage usage)

createFence

GpuFence createFence()

getBindlessTextureHandle

long getBindlessTextureHandle(Handle<TextureResource> texture)

getTextureIndex

default int getTextureIndex(Handle<TextureResource> texture)

Returns an integer index for the given texture, usable in shaders for bindless access. OpenGL: backed by ARB_bindless_texture. Vulkan: backed by descriptor indexing.

queryCapability

<T> T queryCapability(DeviceCapability<T> capability)

supports

default boolean supports(DeviceCapability<Boolean> feature)

readFramebuffer

default byte[] readFramebuffer(int width,
 int height)

Reads back the current framebuffer as RGBA8 byte array. Must be called after endFrame(). May wait for GPU idle. Returns null if readback is not supported.

close

void close()

Specified by:

close in interface AutoCloseable