Graphics API documentation

graphics.get_adapter_info()

graphics.get_adapter_info()

Returns a table describing the active graphics context: the adapter family, its hardware limits, the list of driver-reported extensions, and the set of optional context features supported by the backend.

PARAMETERS

None

RETURNS

`max_texture_size_2d`              [type:number]  max 2D texture dimension in texels
`max_texture_size_3d`              [type:number]  max 3D (volume) texture dimension in texels
`max_texture_size_cube`            [type:number]  max cube map face dimension in texels
`max_texture_array_layers`         [type:number]  max layers in an array texture
`max_framebuffer_width`            [type:number]  max framebuffer width in pixels
`max_framebuffer_height`           [type:number]  max framebuffer height in pixels
`max_color_attachments`            [type:number]  max simultaneous color attachments
`max_samplers_per_stage`           [type:number]  max texture samplers per shader stage
`max_textures_per_stage`           [type:number]  max sampled textures per shader stage
`max_vertex_attributes`            [type:number]  max vertex attributes
`max_vertex_buffers`               [type:number]  max vertex buffer bindings
`max_compute_workgroup_size_x`     [type:number]  max compute workgroup size (X)
`max_compute_workgroup_size_y`     [type:number]  max compute workgroup size (Y)
`max_compute_workgroup_size_z`     [type:number]  max compute workgroup size (Z)
`max_compute_workgroup_invocations` [type:number] max invocations per compute workgroup
`max_compute_shared_memory_size`   [type:number]  max shared memory per compute workgroup (bytes)
`max_uniform_buffer_range`         [type:number]  max bindable uniform buffer range (bytes)
`max_storage_buffer_range`         [type:number]  max bindable storage buffer range (bytes)

`graphics.CONTEXT_FEATURE_MULTI_TARGET_RENDERING`  multi-target rendering
`graphics.CONTEXT_FEATURE_TEXTURE_ARRAY`           texture arrays
`graphics.CONTEXT_FEATURE_COMPUTE_SHADER`          compute shaders
`graphics.CONTEXT_FEATURE_STORAGE_BUFFER`          storage buffers
`graphics.CONTEXT_FEATURE_VSYNC`                   vertical sync
`graphics.CONTEXT_FEATURE_INSTANCING`              hardware instancing
`graphics.CONTEXT_FEATURE_3D_TEXTURES`             3D (volume) textures
`graphics.CONTEXT_FEATURE_ASTC_ARRAY_TEXTURES`     ASTC compressed 2D array textures
`graphics.CONTEXT_FEATURE_BLEND_EQUATION_MIN_MAX`  min/max blend equations

graphics.get_engine_adapters()

graphics.get_engine_adapters()

get the list of graphics adapters that have been registered with the engine

PARAMETERS

None

RETURNS

graphics.BLEND_EQUATION_ADD

graphics.BLEND_EQUATION_MAX

graphics.BLEND_EQUATION_MIN

graphics.BLEND_EQUATION_REVERSE_SUBTRACT

graphics.BLEND_EQUATION_SUBTRACT

graphics.BLEND_FACTOR_CONSTANT_ALPHA

graphics.BLEND_FACTOR_CONSTANT_COLOR

graphics.BLEND_FACTOR_DST_ALPHA

graphics.BLEND_FACTOR_DST_COLOR

graphics.BLEND_FACTOR_ONE

graphics.BLEND_FACTOR_ONE_MINUS_CONSTANT_ALPHA

graphics.BLEND_FACTOR_ONE_MINUS_CONSTANT_COLOR

graphics.BLEND_FACTOR_ONE_MINUS_DST_ALPHA

graphics.BLEND_FACTOR_ONE_MINUS_DST_COLOR

graphics.BLEND_FACTOR_ONE_MINUS_SRC_ALPHA

graphics.BLEND_FACTOR_ONE_MINUS_SRC_COLOR

graphics.BLEND_FACTOR_SRC_ALPHA

graphics.BLEND_FACTOR_SRC_ALPHA_SATURATE

graphics.BLEND_FACTOR_SRC_COLOR

graphics.BLEND_FACTOR_ZERO

graphics.BUFFER_TYPE_COLOR0_BIT

graphics.BUFFER_TYPE_COLOR1_BIT

May be nil if multitarget rendering isn't supported

graphics.BUFFER_TYPE_COLOR2_BIT

May be nil if multitarget rendering isn't supported

graphics.BUFFER_TYPE_COLOR3_BIT

May be nil if multitarget rendering isn't supported

graphics.BUFFER_TYPE_DEPTH_BIT

graphics.BUFFER_TYPE_STENCIL_BIT

graphics.COMPARE_FUNC_ALWAYS

graphics.COMPARE_FUNC_EQUAL

graphics.COMPARE_FUNC_GEQUAL

graphics.COMPARE_FUNC_GREATER

graphics.COMPARE_FUNC_LEQUAL

graphics.COMPARE_FUNC_LESS

graphics.COMPARE_FUNC_NEVER

graphics.COMPARE_FUNC_NOTEQUAL

graphics.COMPRESSION_TYPE_BASIS_ETC1S

graphics.COMPRESSION_TYPE_BASIS_UASTC

graphics.COMPRESSION_TYPE_DEFAULT

graphics.COMPRESSION_TYPE_WEBP

graphics.COMPRESSION_TYPE_WEBP_LOSSY

graphics.CONTEXT_FEATURE_3D_TEXTURES

Context feature flag indicating support for 3D (volume) textures.

graphics.CONTEXT_FEATURE_ASTC_ARRAY_TEXTURES

Context feature flag indicating support for ASTC compressed 2D array textures. Some WebGL/GLES drivers fail array texture ASTC uploads while 2D ASTC works.

graphics.CONTEXT_FEATURE_BLEND_EQUATION_MIN_MAX

Context feature flag indicating support for min/max blend equations. Requires GLES3+ or EXT_blend_minmax.

graphics.CONTEXT_FEATURE_COMPUTE_SHADER

Context feature flag indicating support for compute shaders.

graphics.CONTEXT_FEATURE_INSTANCING

Context feature flag indicating support for hardware instancing.

graphics.CONTEXT_FEATURE_MULTI_TARGET_RENDERING

Context feature flag indicating support for rendering to multiple color targets simultaneously.

graphics.CONTEXT_FEATURE_STORAGE_BUFFER

Context feature flag indicating support for storage buffers.

graphics.CONTEXT_FEATURE_TEXTURE_ARRAY

Context feature flag indicating support for texture arrays.

graphics.CONTEXT_FEATURE_VSYNC

Context feature flag indicating support for vertical sync (vsync).

graphics.FACE_TYPE_BACK

graphics.FACE_TYPE_FRONT

graphics.FACE_TYPE_FRONT_AND_BACK

graphics.STATE_ALPHA_TEST

graphics.STATE_ALPHA_TEST_SUPPORTED

graphics.STATE_BLEND

graphics.STATE_CULL_FACE

graphics.STATE_DEPTH_TEST

graphics.STATE_POLYGON_OFFSET_FILL

graphics.STATE_SCISSOR_TEST

graphics.STATE_STENCIL_TEST

graphics.STENCIL_OP_DECR

graphics.STENCIL_OP_DECR_WRAP

graphics.STENCIL_OP_INCR

graphics.STENCIL_OP_INCR_WRAP

graphics.STENCIL_OP_INVERT

graphics.STENCIL_OP_KEEP

graphics.STENCIL_OP_REPLACE

graphics.STENCIL_OP_ZERO

graphics.TEXTURE_FILTER_DEFAULT

graphics.TEXTURE_FILTER_LINEAR

graphics.TEXTURE_FILTER_LINEAR_MIPMAP_LINEAR

graphics.TEXTURE_FILTER_LINEAR_MIPMAP_NEAREST

graphics.TEXTURE_FILTER_NEAREST

graphics.TEXTURE_FILTER_NEAREST_MIPMAP_LINEAR

graphics.TEXTURE_FILTER_NEAREST_MIPMAP_NEAREST

graphics.TEXTURE_FORMAT_BGRA8U

May be nil if the graphics driver doesn't support it

graphics.TEXTURE_FORMAT_DEPTH

graphics.TEXTURE_FORMAT_LUMINANCE

May be nil if the graphics driver doesn't support it

graphics.TEXTURE_FORMAT_LUMINANCE_ALPHA

May be nil if the graphics driver doesn't support it

graphics.TEXTURE_FORMAT_R16F

May be nil if the graphics driver doesn't support it

graphics.TEXTURE_FORMAT_R32F

May be nil if the graphics driver doesn't support it

graphics.TEXTURE_FORMAT_R32UI

May be nil if the graphics driver doesn't support it

graphics.TEXTURE_FORMAT_R_BC4

May be nil if the graphics driver doesn't support it

graphics.TEXTURE_FORMAT_R_ETC2

May be nil if the graphics driver doesn't support it

graphics.TEXTURE_FORMAT_RG16F

May be nil if the graphics driver doesn't support it

graphics.TEXTURE_FORMAT_RG32F

May be nil if the graphics driver doesn't support it

graphics.TEXTURE_FORMAT_RG_BC5

May be nil if the graphics driver doesn't support it

graphics.TEXTURE_FORMAT_RG_ETC2

May be nil if the graphics driver doesn't support it

graphics.TEXTURE_FORMAT_RGB

May be nil if the graphics driver doesn't support it

graphics.TEXTURE_FORMAT_RGB16F

May be nil if the graphics driver doesn't support it

graphics.TEXTURE_FORMAT_RGB32F

May be nil if the graphics driver doesn't support it

graphics.TEXTURE_FORMAT_RGB_16BPP

May be nil if the graphics driver doesn't support it

graphics.TEXTURE_FORMAT_RGB_BC1

May be nil if the graphics driver doesn't support it

graphics.TEXTURE_FORMAT_RGB_ETC1

May be nil if the graphics driver doesn't support it

graphics.TEXTURE_FORMAT_RGB_PVRTC_2BPPV1

May be nil if the graphics driver doesn't support it

graphics.TEXTURE_FORMAT_RGB_PVRTC_4BPPV1

May be nil if the graphics driver doesn't support it

graphics.TEXTURE_FORMAT_RGBA

May be nil if the graphics driver doesn't support it

graphics.TEXTURE_FORMAT_RGBA16F

May be nil if the graphics driver doesn't support it

graphics.TEXTURE_FORMAT_RGBA32F

May be nil if the graphics driver doesn't support it

graphics.TEXTURE_FORMAT_RGBA32UI

May be nil if the graphics driver doesn't support it

graphics.TEXTURE_FORMAT_RGBA_16BPP

May be nil if the graphics driver doesn't support it

graphics.TEXTURE_FORMAT_RGBA_ASTC_4X4

May be nil if the graphics driver doesn't support it

graphics.TEXTURE_FORMAT_RGBA_BC3

May be nil if the graphics driver doesn't support it

graphics.TEXTURE_FORMAT_RGBA_BC7

May be nil if the graphics driver doesn't support it

graphics.TEXTURE_FORMAT_RGBA_ETC2

May be nil if the graphics driver doesn't support it

graphics.TEXTURE_FORMAT_RGBA_PVRTC_2BPPV1

May be nil if the graphics driver doesn't support it

graphics.TEXTURE_FORMAT_RGBA_PVRTC_4BPPV1

May be nil if the graphics driver doesn't support it

graphics.TEXTURE_FORMAT_STENCIL

graphics.TEXTURE_TYPE_2D

graphics.TEXTURE_TYPE_2D_ARRAY

graphics.TEXTURE_TYPE_3D

May be nil if the graphics driver doesn't support it

graphics.TEXTURE_TYPE_CUBE_MAP

graphics.TEXTURE_TYPE_IMAGE_2D

graphics.TEXTURE_TYPE_IMAGE_3D

May be nil if the graphics driver doesn't support it

graphics.TEXTURE_USAGE_FLAG_COLOR

graphics.TEXTURE_USAGE_FLAG_INPUT

graphics.TEXTURE_USAGE_FLAG_MEMORYLESS

graphics.TEXTURE_USAGE_FLAG_SAMPLE

graphics.TEXTURE_USAGE_FLAG_STORAGE

graphics.TEXTURE_WRAP_CLAMP_TO_BORDER

graphics.TEXTURE_WRAP_CLAMP_TO_EDGE

graphics.TEXTURE_WRAP_MIRRORED_REPEAT

graphics.TEXTURE_WRAP_REPEAT