Merge pull request #341 from bjz/gl_device

Move OpenGL device implementation into separate directory

Author: kvark

src/device/Cargo.toml

@@ -9,5 +9,5 @@ authors = [
 name = "device"
 path = "lib.rs"
 
-[dependencies.gl_generator]
-git = "https://github.com/bjz/gl-rs.git"
+[dependencies.gl]
+path = "../gl_device/gl/"

src/device/lib.rs

@@ -26,11 +26,8 @@
 #[phase(plugin, link)] extern crate log;
 extern crate libc;
 
-// when cargo is ready, re-enable the cfgs
-/* #[cfg(gl)] */ pub use self::gl as back;
-/* #[cfg(gl)] */ pub use gl::GlDevice;
-/* #[cfg(gl)] */ pub use gl::draw::GlCommandBuffer;
-// #[cfg(d3d11)] ... // TODO
+// TODO: Remove these exports once `gl_device` becomes a separate crate.
+pub use self::gl_device as back;
 
 use std::mem;
 
@@ -43,7 +40,10 @@ pub mod shade;
 pub mod state;
 pub mod target;
 pub mod tex;
-/* #[cfg(gl)] */ mod gl;
+
+// TODO: This will become a separate crate once associated items are implemented
+// in rustc and subsequently used in the `Device` trait.
+/* #[cfg(gl)] */ #[path = "../gl_device/lib.rs"] pub mod gl_device;
 
 /// Draw vertex count.
 pub type VertexCount = u32;

src/gfx/lib.rs

@@ -40,8 +40,6 @@ pub use render::state::{DrawState, BlendAdditive, BlendAlpha};
 pub use render::shade;
 pub use render::target::{Frame, Plane, PlaneEmpty, PlaneSurface, PlaneTexture};
 pub use device::Device;
-// when cargo is ready, re-enable the cfgs
-/* #[cfg(gl)] */ pub use device::{GlDevice, GlCommandBuffer};
 pub use device::{attrib, state, tex};
 pub use device::{BufferHandle, BufferInfo, RawBufferHandle, ShaderHandle,
     ProgramHandle, SurfaceHandle, TextureHandle};
@@ -56,3 +54,6 @@ pub use device::shade::{UniformValue,
     ValueF32Matrix2, ValueF32Matrix3, ValueF32Matrix4};
 pub use device::shade::{ShaderSource, StaticBytes, OwnedBytes, ProgramInfo};
 pub use device::target::{Color, ClearData, Layer, Level};
+
+// TODO: Remove this re-export once `gl_device` becomes a separate crate.
+pub use device::gl_device::{GlDevice, GlCommandBuffer};

src/device/gl/draw.rs renamed to src/gl_device/draw.rs

@@ -0,0 +1,13 @@
+[package]
+
+name = "gl"
+version = "0.1.0"
+authors = [
+]
+
+[lib]
+name = "gl"
+path = "lib.rs"
+
+[dependencies.gl_generator]
+git = "https://github.com/bjz/gl-rs.git"

src/gl_device/gl/Cargo.toml

@@ -0,0 +1,30 @@
+// Copyright 2014 The Gfx-rs Developers.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#![crate_name = "gl"]
+#![comment = "An OpenGL loader tailored to gfx-rs's needs."]
+#![license = "ASL2"]
+#![crate_type = "lib"]
+
+#![feature(phase)]
+
+//! An OpenGL loader generated by [gl-rs](https://github.com/bjz/gl-rs).
+//!
+//! This is useful for directly accessing the underlying OpenGL API via the
+//! `GlDevice::with_gl` method. It is also used internally by the `GlDevice`
+//! implementation.
+
+#[phase(plugin)] extern crate gl_generator;
+
+generate_gl_bindings!("gl", "core", "4.5", "struct", [ "GL_EXT_texture_filter_anisotropic" ])

src/gl_device/gl/lib.rs

@@ -12,14 +12,14 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-//! OpenGL implementation of a device, striving to support OpenGL 2.0 with at least VAOs, but using
-//! newer extensions when available.
+//! OpenGL implementation of a device, striving to support OpenGL 2.0 with at
+//! least VAOs, but using newer extensions when available.
 
 #![allow(missing_doc)]
 #![experimental]
 
-#[phase(plugin)] extern crate gl_generator;
 extern crate libc;
+extern crate gl;
 
 use log;
 
@@ -28,18 +28,15 @@ use attrib;
 use Device;
 use blob::{Blob, RefBlobCast};
 
+pub use self::draw::GlCommandBuffer;
 pub use self::info::{Info, PlatformName, Version};
 
-pub mod draw;
+mod draw;
 mod shade;
 mod state;
 mod tex;
 mod info;
 
-mod gl {
-    generate_gl_bindings!("gl", "core", "4.5", "struct", [ "GL_EXT_texture_filter_anisotropic" ])
-}
-
 pub type Buffer         = gl::types::GLuint;
 pub type ArrayBuffer    = gl::types::GLuint;
 pub type Shader         = gl::types::GLuint;
@@ -132,8 +129,9 @@ impl GlDevice {
         }
     }
 
-    /// Access the GL directly using a closure
-    pub fn with_gl(&mut self, fun: |&gl::Gl|) {
+    /// Access the OpenGL directly via a closure. OpenGL types and enumerations
+    /// can be found in the `gl` crate.
+    pub unsafe fn with_gl(&mut self, fun: |&gl::Gl|) {
         self.reset_state();
         fun(&self.gl);
     }
@@ -423,7 +421,7 @@ impl GlDevice {
     }
 }
 
-impl Device<draw::GlCommandBuffer> for GlDevice {
+impl Device<GlCommandBuffer> for GlDevice {
     fn get_capabilities<'a>(&'a self) -> &'a ::Capabilities {
         &self.caps
     }
@@ -434,7 +432,7 @@ impl Device<draw::GlCommandBuffer> for GlDevice {
         }
     }
 
-    fn submit(&mut self, cb: &draw::GlCommandBuffer) {
+    fn submit(&mut self, cb: &GlCommandBuffer) {
         self.reset_state();
         for com in cb.iter() {
             self.process(com);