Struct three_d::core::Context

pub struct Context { /* fields omitted */ }

Contains information about the graphics context to use for rendering and other “global” variables.

Implementations

impl Context

pub fn from_gl_context(context: GLContext) -> Self

Creates a new context from a OpenGL/WebGL context.

pub fn program(
    &self,
    vertex_shader_source: &str,
    fragment_shader_source: &str,
    callback: impl FnOnce(&Program) -> ThreeDResult<()>
) -> ThreeDResult<()>

Compiles a Program with the given vertex and fragment shader source and stores it for later use. If it has already been created, then it is just returned.

pub fn effect(
    &self,
    fragment_shader_source: &str,
    callback: impl FnOnce(&ImageEffect) -> ThreeDResult<()>
) -> ThreeDResult<()>

Compiles an ImageEffect with the given fragment shader source and stores it for later use. If it has already been created, then it is just returned.

pub fn camera2d(
    &self,
    viewport: Viewport,
    callback: impl FnOnce(&Camera) -> ThreeDResult<()>
) -> ThreeDResult<()>

Returns a camera for viewing 2D content.

Methods from Deref<Target = GLContext>

pub fn finish(&self)

This is supported on non-WebAssembly only.

pub fn create_shader(&self, type_: ShaderType) -> Option<Shader>

This is supported on non-WebAssembly only.

pub fn compile_shader(&self, source: &str, shader: &Shader)

This is supported on non-WebAssembly only.

pub fn get_shader_info_log(&self, shader: &Shader) -> Option<String>

This is supported on non-WebAssembly only.

pub fn delete_shader(&self, shader: Option<&Shader>)

This is supported on non-WebAssembly only.

pub fn attach_shader(&self, program: &Program, shader: &Shader)

This is supported on non-WebAssembly only.

pub fn detach_shader(&self, program: &Program, shader: &Shader)

This is supported on non-WebAssembly only.

pub fn get_program_parameter(&self, program: &Program, pname: u32) -> u32

This is supported on non-WebAssembly only.

pub fn get_active_attrib(&self, program: &Program, index: u32) -> ActiveInfo

This is supported on non-WebAssembly only.

pub fn get_active_uniform(&self, program: &Program, index: u32) -> ActiveInfo

This is supported on non-WebAssembly only.

pub fn create_buffer(&self) -> Option<Buffer>

This is supported on non-WebAssembly only.

pub fn delete_buffer(&self, buffer: &Buffer)

This is supported on non-WebAssembly only.

pub fn bind_buffer_base(&self, target: u32, index: u32, buffer: &Buffer)

This is supported on non-WebAssembly only.

pub fn bind_buffer(&self, target: u32, buffer: &Buffer)

This is supported on non-WebAssembly only.

pub fn unbind_buffer(&self, target: u32)

This is supported on non-WebAssembly only.

pub fn get_uniform_block_index(&self, program: &Program, name: &str) -> u32

This is supported on non-WebAssembly only.

pub fn uniform_block_binding(
    &self,
    program: &Program,
    location: u32,
    index: u32
)

This is supported on non-WebAssembly only.

pub fn buffer_data(&self, target: u32, size_in_bytes: u32, usage: u32)

This is supported on non-WebAssembly only.

pub fn buffer_data_u8(&self, target: u32, data: &[u8], usage: u32)

This is supported on non-WebAssembly only.

pub fn buffer_data_u16(&self, target: u32, data: &[u16], usage: u32)

This is supported on non-WebAssembly only.

pub fn buffer_data_u32(&self, target: u32, data: &[u32], usage: u32)

This is supported on non-WebAssembly only.

pub fn buffer_data_f32(&self, target: u32, data: &[f32], usage: u32)

This is supported on non-WebAssembly only.

pub fn create_vertex_array(&self) -> Option<VertexArrayObject>

This is supported on non-WebAssembly only.

pub fn bind_vertex_array(&self, array: &VertexArrayObject)

This is supported on non-WebAssembly only.

pub fn create_program(&self) -> Program

This is supported on non-WebAssembly only.

pub fn link_program(&self, program: &Program) -> bool

This is supported on non-WebAssembly only.

pub fn get_program_info_log(&self, program: &Program) -> Option<String>

This is supported on non-WebAssembly only.

pub fn use_program(&self, program: &Program)

This is supported on non-WebAssembly only.

pub fn unuse_program(&self)

This is supported on non-WebAssembly only.

pub fn delete_program(&self, program: &Program)

This is supported on non-WebAssembly only.

pub fn get_attrib_location(
    &self,
    program: &Program,
    name: &str
) -> Option<AttributeLocation>

This is supported on non-WebAssembly only.

pub fn enable_vertex_attrib_array(&self, location: AttributeLocation)

This is supported on non-WebAssembly only.

pub fn disable_vertex_attrib_array(&self, location: AttributeLocation)

This is supported on non-WebAssembly only.

pub fn vertex_attrib_pointer(
    &self,
    location: AttributeLocation,
    size: u32,
    data_type: DataType,
    normalized: bool,
    stride: u32,
    offset: u32
)

This is supported on non-WebAssembly only.

pub fn vertex_attrib_divisor(&self, location: AttributeLocation, divisor: u32)

This is supported on non-WebAssembly only.

pub fn get_uniform_location(
    &self,
    program: &Program,
    name: &str
) -> Option<UniformLocation>

This is supported on non-WebAssembly only.

pub fn uniform1i(&self, location: &UniformLocation, data: i32)

This is supported on non-WebAssembly only.

pub fn uniform1f(&self, location: &UniformLocation, data: f32)

This is supported on non-WebAssembly only.

pub fn uniform2fv(&self, location: &UniformLocation, data: &[f32])

This is supported on non-WebAssembly only.

pub fn uniform3fv(&self, location: &UniformLocation, data: &[f32])

This is supported on non-WebAssembly only.

pub fn uniform4fv(&self, location: &UniformLocation, data: &[f32])

This is supported on non-WebAssembly only.

pub fn uniform_matrix2fv(&self, location: &UniformLocation, data: &[f32])

This is supported on non-WebAssembly only.

pub fn uniform_matrix3fv(&self, location: &UniformLocation, data: &[f32])

This is supported on non-WebAssembly only.

pub fn uniform_matrix4fv(&self, location: &UniformLocation, data: &[f32])

This is supported on non-WebAssembly only.

pub fn draw_buffers(&self, draw_buffers: &[u32])

This is supported on non-WebAssembly only.

pub fn create_framebuffer(&self) -> Option<Framebuffer>

This is supported on non-WebAssembly only.

pub fn bind_framebuffer(&self, target: u32, framebuffer: Option<&Framebuffer>)

This is supported on non-WebAssembly only.

pub fn delete_framebuffer(&self, framebuffer: Option<&Framebuffer>)

This is supported on non-WebAssembly only.

pub fn check_framebuffer_status(&self) -> Result<(), String>

This is supported on non-WebAssembly only.

pub fn blit_framebuffer(
    &self,
    src_x0: u32,
    src_y0: u32,
    src_x1: u32,
    src_y1: u32,
    dst_x0: u32,
    dst_y0: u32,
    dst_x1: u32,
    dst_y1: u32,
    mask: u32,
    filter: u32
)

This is supported on non-WebAssembly only.

pub fn viewport(&self, x: i32, y: i32, width: i32, height: i32)

This is supported on non-WebAssembly only.

pub fn clear_color(&self, red: f32, green: f32, blue: f32, alpha: f32)

This is supported on non-WebAssembly only.

pub fn clear_depth(&self, depth: f32)

This is supported on non-WebAssembly only.

pub fn clear(&self, mask: u32)

This is supported on non-WebAssembly only.

pub fn enable(&self, cap: u32)

This is supported on non-WebAssembly only.

pub fn disable(&self, cap: u32)

This is supported on non-WebAssembly only.

pub fn blend_func(&self, sfactor: u32, dfactor: u32)

This is supported on non-WebAssembly only.

pub fn blend_func_separate(
    &self,
    src_rgb: u32,
    dst_rgb: u32,
    src_alpha: u32,
    dst_alpha: u32
)

This is supported on non-WebAssembly only.

pub fn blend_equation(&self, mode: u32)

This is supported on non-WebAssembly only.

pub fn blend_equation_separate(&self, mode_rgb: u32, mode_alpha: u32)

This is supported on non-WebAssembly only.

pub fn cull_face(&self, mode: u32)

This is supported on non-WebAssembly only.

pub fn scissor(&self, x: i32, y: i32, width: i32, height: i32)

This is supported on non-WebAssembly only.

pub fn depth_func(&self, func: u32)

This is supported on non-WebAssembly only.

pub fn color_mask(&self, red: bool, green: bool, blue: bool, alpha: bool)

This is supported on non-WebAssembly only.

pub fn depth_mask(&self, flag: bool)

This is supported on non-WebAssembly only.

pub fn create_texture(&self) -> Option<Texture>

This is supported on non-WebAssembly only.

pub fn active_texture(&self, texture: u32)

This is supported on non-WebAssembly only.

pub fn bind_texture(&self, target: u32, texture: &Texture)

This is supported on non-WebAssembly only.

pub fn generate_mipmap(&self, target: u32)

This is supported on non-WebAssembly only.

pub fn tex_storage_2d(
    &self,
    target: u32,
    levels: u32,
    internalformat: u32,
    width: u32,
    height: u32
)

This is supported on non-WebAssembly only.

pub fn tex_storage_3d(
    &self,
    target: u32,
    levels: u32,
    internalformat: u32,
    width: u32,
    height: u32,
    depth: u32
)

This is supported on non-WebAssembly only.

pub fn tex_image_2d(
    &self,
    target: u32,
    level: u32,
    internalformat: u32,
    width: u32,
    height: u32,
    border: u32,
    format: u32,
    data_type: DataType
)

This is supported on non-WebAssembly only.

pub fn tex_image_2d_with_u8_data(
    &self,
    target: u32,
    level: u32,
    internalformat: u32,
    width: u32,
    height: u32,
    border: u32,
    format: u32,
    data_type: DataType,
    pixels: &[u8]
)

This is supported on non-WebAssembly only.

pub fn tex_sub_image_2d_with_u8_data(
    &self,
    target: u32,
    level: u32,
    x_offset: u32,
    y_offset: u32,
    width: u32,
    height: u32,
    format: u32,
    data_type: DataType,
    pixels: &[u8]
)

This is supported on non-WebAssembly only.

pub fn tex_image_2d_with_f32_data(
    &self,
    target: u32,
    level: u32,
    internalformat: u32,
    width: u32,
    height: u32,
    border: u32,
    format: u32,
    data_type: DataType,
    pixels: &[f32]
)

This is supported on non-WebAssembly only.

pub fn tex_sub_image_2d_with_f32_data(
    &self,
    target: u32,
    level: u32,
    x_offset: u32,
    y_offset: u32,
    width: u32,
    height: u32,
    format: u32,
    data_type: DataType,
    pixels: &[f32]
)

This is supported on non-WebAssembly only.

pub fn tex_sub_image_2d_with_u32_data(
    &self,
    target: u32,
    level: u32,
    x_offset: u32,
    y_offset: u32,
    width: u32,
    height: u32,
    format: u32,
    data_type: DataType,
    pixels: &[u32]
)

This is supported on non-WebAssembly only.

pub fn tex_image_3d(
    &self,
    target: u32,
    level: u32,
    internalformat: u32,
    width: u32,
    height: u32,
    depth: u32,
    format: u32,
    data_type: DataType
)

This is supported on non-WebAssembly only.

pub fn tex_image_3d_with_u16_data(
    &self,
    target: u32,
    level: u32,
    internalformat: u32,
    width: u32,
    height: u32,
    depth: u32,
    border: u32,
    format: u32,
    data_type: DataType,
    pixels: &[u16]
)

This is supported on non-WebAssembly only.

pub fn tex_parameteri(&self, target: u32, pname: u32, param: i32)

This is supported on non-WebAssembly only.

pub fn delete_texture(&self, texture: &Texture)

This is supported on non-WebAssembly only.

pub fn framebuffer_texture_2d(
    &self,
    target: u32,
    attachment: u32,
    textarget: u32,
    texture: &Texture,
    level: u32
)

This is supported on non-WebAssembly only.

pub fn framebuffer_texture_layer(
    &self,
    target: u32,
    attachment: u32,
    texture: &Texture,
    level: u32,
    layer: u32
)

This is supported on non-WebAssembly only.

pub fn draw_arrays(&self, mode: u32, first: u32, count: u32)

This is supported on non-WebAssembly only.

pub fn draw_arrays_instanced(
    &self,
    mode: u32,
    first: u32,
    count: u32,
    instance_count: u32
)

This is supported on non-WebAssembly only.

pub fn draw_elements(
    &self,
    mode: u32,
    count: u32,
    data_type: DataType,
    offset: u32
)

This is supported on non-WebAssembly only.

pub fn draw_elements_instanced(
    &self,
    mode: u32,
    count: u32,
    data_type: DataType,
    offset: u32,
    instance_count: u32
)

This is supported on non-WebAssembly only.

pub fn read_pixels(
    &self,
    x: u32,
    y: u32,
    width: u32,
    height: u32,
    format: u32,
    data_type: DataType
)

This is supported on non-WebAssembly only.

pub fn read_pixels_with_u8_data(
    &self,
    x: u32,
    y: u32,
    width: u32,
    height: u32,
    format: u32,
    data_type: DataType,
    dst_data: &mut [u8]
)

This is supported on non-WebAssembly only.

pub fn read_pixels_with_f32_data(
    &self,
    x: u32,
    y: u32,
    width: u32,
    height: u32,
    format: u32,
    data_type: DataType,
    dst_data: &mut [f32]
)

This is supported on non-WebAssembly only.

pub fn read_pixels_with_u32_data(
    &self,
    x: u32,
    y: u32,
    width: u32,
    height: u32,
    format: u32,
    data_type: DataType,
    dst_data: &mut [u32]
)

This is supported on non-WebAssembly only.

pub fn flush(&self)

This is supported on non-WebAssembly only.

pub fn fence_sync(&self) -> Sync

This is supported on non-WebAssembly only.

pub fn client_wait_sync(&self, sync: &Sync, flags: u32, timeout: u32) -> u32

This is supported on non-WebAssembly only.

pub fn delete_sync(&self, sync: &Sync)

This is supported on non-WebAssembly only.

Trait Implementations

impl Clone for Context

fn clone(&self) -> Context

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Deref for Context

type Target = GLContext

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.