Struct RendererDataBuilder 

pub struct RendererDataBuilder<VertexShaderId: Id = IdDefault, FragmentShaderId: Id = IdDefault, ProgramId: Id = IdDefault, UniformId: Id + IdName = IdDefault, BufferId: Id = IdDefault, AttributeId: Id + IdName = IdDefault, TextureId: Id = IdDefault, FramebufferId: Id = IdDefault, TransformFeedbackId: Id = IdDefault, VertexArrayObjectId: Id = IdDefault, UserCtx: Clone + 'static = ()> { /* private fields */ }

Implementations

impl<VertexShaderId: Id, FragmentShaderId: Id, ProgramId: Id, UniformId: Id + IdName, BufferId: Id, AttributeId: Id + IdName, TextureId: Id, FramebufferId: Id, TransformFeedbackId: Id, VertexArrayObjectId: Id, UserCtx: Clone + 'static> RendererDataBuilder<VertexShaderId, FragmentShaderId, ProgramId, UniformId, BufferId, AttributeId, TextureId, FramebufferId, TransformFeedbackId, VertexArrayObjectId, UserCtx>

Public API

pub fn texture(&self, texture_id: &TextureId) -> Option<&Texture<TextureId>>

This is the only internal storage available publicly from the builder, because it is necessary to use it during the build process for framebuffers.

pub fn set_canvas(&mut self, canvas: HtmlCanvasElement) -> &mut Self

Save the canvas that will be rendered to and get its associated WebGL2 rendering context

pub fn add_fragment_shader_src( &mut self, id: FragmentShaderId, fragment_shader_src: impl Into<String>, ) -> &mut Self

Saves a fragment shader source and its corresponding id

pub fn add_vertex_shader_src( &mut self, id: VertexShaderId, vertex_shader_src: impl Into<String>, ) -> &mut Self

Saves a vertex shader source and its corresponding id

pub fn add_program_link( &mut self, program_link: impl Into<ProgramLink<ProgramId, VertexShaderId, FragmentShaderId>>, ) -> &mut Self

Saves a link between a vertex shader id and a fragment shader id.

During the RendererData build process, this program_link is used to link a new WebGL2 program together by associating the vertex shader id and the fragment shader id with their corresponding compiled shaders.

pub fn add_program_links( &mut self, program_links: impl Into<Bridge<ProgramLink<ProgramId, VertexShaderId, FragmentShaderId>>>, ) -> &mut Self

pub fn set_render_callback( &mut self, render_callback: impl Into<RenderCallback<VertexShaderId, FragmentShaderId, ProgramId, UniformId, BufferId, AttributeId, TextureId, FramebufferId, TransformFeedbackId, VertexArrayObjectId, UserCtx>>, ) -> &mut Self

Save a callback that will be called each time it is time to render a new frame

pub fn set_user_ctx(&mut self, ctx: impl Into<UserCtx>) -> &mut Self

Save as arbitrary user context that can be accessed from within the render callback

This can include stateful data and anything else that might be necessary to access while performing a render.

pub fn add_uniform_link( &mut self, uniform_link: impl Into<UniformLink<ProgramId, UniformId>>, ) -> &mut Self

Saves a link that will be used to build a uniform at build time.

I.e. once all WebGL shaders are compiled and all programs are linked, all uniforms will be found within their associated programs, and will be saved with their associated update functions.

pub fn add_uniform_links( &mut self, uniform_links: impl Into<Bridge<UniformLink<ProgramId, UniformId>>>, ) -> &mut Self

pub fn add_buffer_link( &mut self, buffer_link: impl Into<BufferLink<BufferId>>, ) -> &mut Self

Saves a link that will be used to build a WebGL buffer at build time.

pub fn add_buffer_links( &mut self, buffer_links: impl Into<Bridge<BufferLink<BufferId>>>, ) -> &mut Self

pub fn add_attribute_link( &mut self, attribute_link: impl Into<AttributeLink<VertexArrayObjectId, BufferId, AttributeId>>, ) -> &mut Self

Saves a link that will be used to build a a WebGL attribute at build time.

pub fn add_attribute_links( &mut self, attribute_links: impl Into<Bridge<AttributeLink<VertexArrayObjectId, BufferId, AttributeId>>>, ) -> &mut Self

pub fn add_texture_link( &mut self, texture_link: impl Into<TextureLink<TextureId>>, ) -> &mut Self

Saves a link that will be used to build a buffer/attribute pair at build time.

pub fn add_texture_links( &mut self, texture_links: impl Into<Bridge<TextureLink<TextureId>>>, ) -> &mut Self

pub fn add_framebuffer_link( &mut self, framebuffer_link: impl Into<FramebufferLink<FramebufferId, TextureId>>, ) -> &mut Self

Saves a link that will be used to build a framebuffer at build time

pub fn add_framebuffer_links( &mut self, framebuffer_links: impl Into<Bridge<FramebufferLink<FramebufferId, TextureId>>>, ) -> &mut Self

pub fn add_transform_feedback_link( &mut self, transform_feedback_link: impl Into<TransformFeedbackLink<TransformFeedbackId>>, ) -> &mut Self

Saves a link that will be used to build a transformFeedback at build time

pub fn add_transform_feedback_links( &mut self, transform_feedback_links: impl Into<Bridge<TransformFeedbackLink<TransformFeedbackId>>>, ) -> &mut Self

pub fn add_vao_link( &mut self, vertex_array_object_id: impl Into<VertexArrayObjectId>, ) -> &mut Self

Saves an id that will be used to create a VAO at build time

This VAO can then be referenced by AttributeLinks

pub fn add_vao_links( &mut self, vao_links: impl Into<Bridge<VertexArrayObjectId>>, ) -> &mut Self

pub fn set_get_context_callback( &mut self, get_context_callback: impl Into<GetContextCallback>, ) -> &mut Self

pub fn build_renderer( self, ) -> Result<Renderer<VertexShaderId, FragmentShaderId, ProgramId, UniformId, BufferId, AttributeId, TextureId, FramebufferId, TransformFeedbackId, VertexArrayObjectId, UserCtx>, RendererBuilderError>

Compiles all vertex shaders and fragment shaders. Links together any programs that have been specified. Outputs the final RendererData, wrapped in a top-level Renderer.

pub fn build_renderer_data( self, ) -> Result<RendererData<VertexShaderId, FragmentShaderId, ProgramId, UniformId, BufferId, AttributeId, TextureId, FramebufferId, TransformFeedbackId, VertexArrayObjectId, UserCtx>, RendererBuilderError>

Compiles all vertex shaders and fragment shaders. Links together any programs that have been specified. Outputs the final RendererData.

Trait Implementations

impl<VertexShaderId: Clone + Id, FragmentShaderId: Clone + Id, ProgramId: Clone + Id, UniformId: Clone + Id + IdName, BufferId: Clone + Id, AttributeId: Clone + Id + IdName, TextureId: Clone + Id, FramebufferId: Clone + Id, TransformFeedbackId: Clone + Id, VertexArrayObjectId: Clone + Id, UserCtx: Clone + Clone + 'static> Clone for RendererDataBuilder<VertexShaderId, FragmentShaderId, ProgramId, UniformId, BufferId, AttributeId, TextureId, FramebufferId, TransformFeedbackId, VertexArrayObjectId, UserCtx>

fn clone( &self, ) -> RendererDataBuilder<VertexShaderId, FragmentShaderId, ProgramId, UniformId, BufferId, AttributeId, TextureId, FramebufferId, TransformFeedbackId, VertexArrayObjectId, UserCtx>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<VertexShaderId: Debug + Id, FragmentShaderId: Debug + Id, ProgramId: Debug + Id, UniformId: Debug + Id + IdName, BufferId: Debug + Id, AttributeId: Debug + Id + IdName, TextureId: Debug + Id, FramebufferId: Debug + Id, TransformFeedbackId: Debug + Id, VertexArrayObjectId: Debug + Id, UserCtx: Debug + Clone + 'static> Debug for RendererDataBuilder<VertexShaderId, FragmentShaderId, ProgramId, UniformId, BufferId, AttributeId, TextureId, FramebufferId, TransformFeedbackId, VertexArrayObjectId, UserCtx>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<VertexShaderId: Id, FragmentShaderId: Id, ProgramId: Id, UniformId: Id + IdName, BufferId: Id, AttributeId: Id + IdName, TextureId: Id, FramebufferId: Id, TransformFeedbackId: Id, VertexArrayObjectId: Id, UserCtx: Clone> Default for RendererDataBuilder<VertexShaderId, FragmentShaderId, ProgramId, UniformId, BufferId, AttributeId, TextureId, FramebufferId, TransformFeedbackId, VertexArrayObjectId, UserCtx>

fn default() -> Self

Returns the “default value” for a type.