Struct Factory

pub struct Factory { /* private fields */ }

GL resource factory.

Implementations

impl Factory

pub fn new(share: Rc<Share>) -> Factory

Create a new Factory.

pub fn create_command_buffer(&mut self) -> CommandBuffer

Examples found in repository

examples/window.rs (line 35)

pub fn main() {
    let sdl_context = sdl2::init().unwrap();
    let video = sdl_context.video().unwrap();
    // Request opengl core 3.2 for example:
    video.gl_attr().set_context_profile(sdl2::video::GLProfile::Core);
    video.gl_attr().set_context_version(3, 2);
    let builder = video.window("SDL Window", 1024, 768);
    let (window, _gl_context, mut device, mut factory, main_color, _main_depth) =
        gfx_window_sdl::init::<Rgba8, DepthStencil>(&video, builder).unwrap();

    let mut encoder: gfx::Encoder<_, _> = factory.create_command_buffer().into();

    let mut events = sdl_context.event_pump().unwrap();

    let mut running = true;
    while running {
        // handle events
        for event in events.poll_iter() {
            match event {
                Event::Quit { .. } |
                Event::KeyUp { keycode: Some(Keycode::Escape), .. } => {
                    running = false;
                }
                _ => {}
            }
        }

        // draw a frame
        encoder.clear(&main_color, CLEAR_COLOR);
        // <- draw actual stuff here
        encoder.flush(&mut device);
        window.gl_swap_window();
        device.cleanup();
    }
}

Trait Implementations

impl Clone for Factory

fn clone(&self) -> Factory

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Factory<Resources> for Factory

fn get_capabilities(&self) -> &Capabilities

Returns the capabilities of this Factory. This usually depends on the graphics API being used.

fn create_buffer_raw( &mut self, info: Info, ) -> Result<RawBuffer<Resources>, CreationError>

fn create_buffer_immutable_raw( &mut self, data: &[u8], stride: usize, role: Role, bind: Bind, ) -> Result<RawBuffer<Resources>, CreationError>

fn create_shader( &mut self, stage: Stage, code: &[u8], ) -> Result<Shader<Resources>, CreateShaderError>

Compiles a shader source into a Shader object that can be used to create a shader Program.

fn create_program( &mut self, shader_set: &ShaderSet<Resources>, ) -> Result<Program<Resources>, CreateProgramError>

Creates a new shader Program for the supplied ShaderSet.

fn create_pipeline_state_raw( &mut self, program: &Program<Resources>, desc: &Descriptor, ) -> Result<RawPipelineState<Resources>, CreationError>

Creates a new RawPipelineState. To create a safely typed PipelineState, see the FactoryExt trait and pso module, both in the gfx crate.

fn create_texture_raw( &mut self, desc: Info, hint: Option<ChannelType>, data_opt: Option<(&[&[u8]], Mipmap)>, ) -> Result<RawTexture<Resources>, CreationError>

Create a new empty raw texture with no data. The channel type parameter is a hint, required to assist backends that have no concept of typeless formats (OpenGL). The initial data, if given, has to be provided for all mip levels and slices: Slice0.Mip0, Slice0.Mip1, …, Slice1.Mip0, …

fn view_buffer_as_shader_resource_raw( &mut self, hbuf: &RawBuffer<Resources>, format: Format, ) -> Result<RawShaderResourceView<Resources>, ResourceViewError>

fn view_buffer_as_unordered_access_raw( &mut self, _hbuf: &RawBuffer<Resources>, ) -> Result<RawUnorderedAccessView<Resources>, ResourceViewError>

fn view_texture_as_shader_resource_raw( &mut self, htex: &RawTexture<Resources>, desc: ResourceDesc, ) -> Result<RawShaderResourceView<Resources>, ResourceViewError>

fn view_texture_as_unordered_access_raw( &mut self, _htex: &RawTexture<Resources>, ) -> Result<RawUnorderedAccessView<Resources>, ResourceViewError>

fn view_texture_as_render_target_raw( &mut self, htex: &RawTexture<Resources>, desc: RenderDesc, ) -> Result<RawRenderTargetView<Resources>, TargetViewError>

fn view_texture_as_depth_stencil_raw( &mut self, htex: &RawTexture<Resources>, desc: DepthStencilDesc, ) -> Result<RawDepthStencilView<Resources>, TargetViewError>

fn create_sampler(&mut self, info: SamplerInfo) -> Sampler<Resources>

fn read_mapping<'a, 'b, T>( &'a mut self, buf: &'b Buffer<Resources, T>, ) -> Result<Reader<'b, Resources, T>, Error>

where T: Copy,

Acquire a mapping Reader

fn write_mapping<'a, 'b, T>( &'a mut self, buf: &'b Buffer<Resources, T>, ) -> Result<Writer<'b, Resources, T>, Error>

where T: Copy,

Acquire a mapping Writer

fn create_buffer_immutable<T>( &mut self, data: &[T], role: Role, bind: Bind, ) -> Result<Buffer<R, T>, CreationError>

where T: Pod,

fn create_buffer<T>( &mut self, num: usize, role: Role, usage: Usage, bind: Bind, ) -> Result<Buffer<R, T>, CreationError>

fn create_shader_vertex( &mut self, code: &[u8], ) -> Result<VertexShader<R>, CreateShaderError>

Compiles a VertexShader from source.

fn create_shader_hull( &mut self, code: &[u8], ) -> Result<HullShader<R>, CreateShaderError>

Compiles a HullShader from source.

fn create_shader_domain( &mut self, code: &[u8], ) -> Result<DomainShader<R>, CreateShaderError>

Compiles a VertexShader from source.

fn create_shader_geometry( &mut self, code: &[u8], ) -> Result<GeometryShader<R>, CreateShaderError>

Compiles a GeometryShader from source.

fn create_shader_pixel( &mut self, code: &[u8], ) -> Result<PixelShader<R>, CreateShaderError>

Compiles a PixelShader from source. This is the same as what some APIs call a fragment shader.

fn create_texture<S>( &mut self, kind: Kind, levels: u8, bind: Bind, usage: Usage, channel_hint: Option<ChannelType>, ) -> Result<Texture<R, S>, CreationError>

where S: SurfaceTyped,

fn view_buffer_as_shader_resource<T>( &mut self, buf: &Buffer<R, T>, ) -> Result<ShaderResourceView<R, T>, ResourceViewError>

where T: Formatted,

fn view_buffer_as_unordered_access<T>( &mut self, buf: &Buffer<R, T>, ) -> Result<UnorderedAccessView<R, T>, ResourceViewError>

fn view_texture_as_shader_resource<T>( &mut self, tex: &Texture<R, <T as Formatted>::Surface>, levels: (u8, u8), swizzle: Swizzle, ) -> Result<ShaderResourceView<R, <T as Formatted>::View>, ResourceViewError>

where T: TextureFormat,

fn view_texture_as_unordered_access<T>( &mut self, tex: &Texture<R, <T as Formatted>::Surface>, ) -> Result<UnorderedAccessView<R, <T as Formatted>::View>, ResourceViewError>

where T: TextureFormat,

fn view_texture_as_render_target<T>( &mut self, tex: &Texture<R, <T as Formatted>::Surface>, level: u8, layer: Option<u16>, ) -> Result<RenderTargetView<R, T>, TargetViewError>

where T: RenderFormat,

fn view_texture_as_depth_stencil<T>( &mut self, tex: &Texture<R, <T as Formatted>::Surface>, level: u8, layer: Option<u16>, flags: DepthStencilFlags, ) -> Result<DepthStencilView<R, T>, TargetViewError>

where T: DepthFormat,

fn view_texture_as_depth_stencil_trivial<T>( &mut self, tex: &Texture<R, <T as Formatted>::Surface>, ) -> Result<DepthStencilView<R, T>, TargetViewError>

where T: DepthFormat,

fn create_texture_immutable_u8<T>( &mut self, kind: Kind, mipmap: Mipmap, data: &[&[u8]], ) -> Result<(Texture<R, <T as Formatted>::Surface>, ShaderResourceView<R, <T as Formatted>::View>), CombinedError>

where T: TextureFormat,

fn create_texture_immutable<T>( &mut self, kind: Kind, mipmap: Mipmap, data: &[&[<<T as Formatted>::Surface as SurfaceTyped>::DataType]], ) -> Result<(Texture<R, <T as Formatted>::Surface>, ShaderResourceView<R, <T as Formatted>::View>), CombinedError>

where T: TextureFormat,

fn create_render_target<T>( &mut self, width: u16, height: u16, ) -> Result<(Texture<R, <T as Formatted>::Surface>, ShaderResourceView<R, <T as Formatted>::View>, RenderTargetView<R, T>), CombinedError>

where T: RenderFormat + TextureFormat,

fn create_depth_stencil<T>( &mut self, width: u16, height: u16, ) -> Result<(Texture<R, <T as Formatted>::Surface>, ShaderResourceView<R, <T as Formatted>::View>, DepthStencilView<R, T>), CombinedError>

where T: DepthFormat + TextureFormat,

fn create_depth_stencil_view_only<T>( &mut self, width: u16, height: u16, ) -> Result<DepthStencilView<R, T>, CombinedError>

where T: DepthFormat + TextureFormat,