Skip to content

Commit

Permalink
api: unify surfaceless APIs on context
Browse files Browse the repository at this point in the history 
The API was implemented by all backend, this patch simply promotes it
to the top-level trait.
  • Loading branch information
@kchibisov
kchibisov committed Nov 12, 2024
1 parent d5edc13 commit c0b8350
Show file tree
Hide file tree
Showing 6 changed files with 75 additions and 83 deletions.
11 changes: 1 addition & 10 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,16 +1,7 @@
# Unreleased

- Added `PossiblyCurrentContext::make_not_current_in_place(&self)` for when `Send` capability of `NotCurrentContext` is not required.
- Added `NotCurrentContext::make_current_surfaceless(self)` and
`PossiblyCurrentContext::make_current_surfaceless(&self)` in the `Cgl`
implementation to allow the use of surfaceless contexts on MacOS.
- Added `NotCurrentContext::make_current_surfaceless(self)` and
`PossiblyCurrentContext::make_current_surfaceless(&self)` in the `Glx`
implementation to allow the use of surfaceless contexts with GLX.
- Added `NotCurrentContext::make_current_surfaceless(self)` and
`PossiblyCurrentContext::make_current_surfaceless(&self)` in the `Wgl`
implementation to allow the use of surfaceless contexts with WGL.

- **Breaking:** Added `make_current_surfaceless(self)` for `{Possibly,Not}CurrentGlContext`.

# Version 0.32.1

Expand Down
23 changes: 9 additions & 14 deletions glutin/src/api/cgl/context.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,13 +74,6 @@ pub struct NotCurrentContext {
}

impl NotCurrentContext {
/// Make a [`Self::PossiblyCurrentContext`] indicating that the context
/// could be current on the thread.
pub fn make_current_surfaceless(self) -> Result<PossiblyCurrentContext> {
self.inner.make_current_surfaceless()?;
Ok(PossiblyCurrentContext { inner: self.inner, _nosendsync: PhantomData })
}

fn new(inner: ContextInner) -> Self {
Self { inner, _nosync: PhantomData }
}
Expand Down Expand Up @@ -109,6 +102,11 @@ impl NotCurrentGlContext for NotCurrentContext {
) -> Result<Self::PossiblyCurrentContext> {
Err(self.inner.make_current_draw_read(surface_draw, surface_read).into())
}

fn make_current_surfaceless(self) -> Result<PossiblyCurrentContext> {
self.inner.make_current_surfaceless()?;
Ok(PossiblyCurrentContext { inner: self.inner, _nosendsync: PhantomData })
}
}

impl GlContext for NotCurrentContext {
Expand Down Expand Up @@ -150,13 +148,6 @@ pub struct PossiblyCurrentContext {
_nosendsync: PhantomData<*mut ()>,
}

impl PossiblyCurrentContext {
/// Make this context current on the calling thread.
pub fn make_current_surfaceless(&self) -> Result<()> {
self.inner.make_current_surfaceless()
}
}

impl PossiblyCurrentGlContext for PossiblyCurrentContext {
type NotCurrentContext = NotCurrentContext;
type Surface<T: SurfaceTypeTrait> = Surface<T>;
Expand Down Expand Up @@ -189,6 +180,10 @@ impl PossiblyCurrentGlContext for PossiblyCurrentContext {
) -> Result<()> {
Err(self.inner.make_current_draw_read(surface_draw, surface_read).into())
}

fn make_current_surfaceless(&self) -> Result<()> {
self.inner.make_current_surfaceless()
}
}

impl GlContext for PossiblyCurrentContext {
Expand Down
23 changes: 9 additions & 14 deletions glutin/src/api/egl/context.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -172,13 +172,6 @@ pub struct NotCurrentContext {
}

impl NotCurrentContext {
/// Make a [`Self::PossiblyCurrentContext`] indicating that the context
/// could be current on the thread.
pub fn make_current_surfaceless(self) -> Result<PossiblyCurrentContext> {
self.inner.make_current_surfaceless()?;
Ok(PossiblyCurrentContext { inner: self.inner, _nosendsync: PhantomData })
}

fn new(inner: ContextInner) -> Self {
Self { inner }
}
Expand Down Expand Up @@ -208,6 +201,11 @@ impl NotCurrentGlContext for NotCurrentContext {
self.inner.make_current_draw_read(surface_draw, surface_read)?;
Ok(PossiblyCurrentContext { inner: self.inner, _nosendsync: PhantomData })
}

fn make_current_surfaceless(self) -> Result<PossiblyCurrentContext> {
self.inner.make_current_surfaceless()?;
Ok(PossiblyCurrentContext { inner: self.inner, _nosendsync: PhantomData })
}
}

impl GlContext for NotCurrentContext {
Expand Down Expand Up @@ -247,13 +245,6 @@ pub struct PossiblyCurrentContext {
_nosendsync: PhantomData<EGLContext>,
}

impl PossiblyCurrentContext {
/// Make this context current on the calling thread.
pub fn make_current_surfaceless(&self) -> Result<()> {
self.inner.make_current_surfaceless()
}
}

impl PossiblyCurrentGlContext for PossiblyCurrentContext {
type NotCurrentContext = NotCurrentContext;
type Surface<T: SurfaceTypeTrait> = Surface<T>;
Expand Down Expand Up @@ -285,6 +276,10 @@ impl PossiblyCurrentGlContext for PossiblyCurrentContext {
) -> Result<()> {
self.inner.make_current_draw_read(surface_draw, surface_read)
}

fn make_current_surfaceless(&self) -> Result<()> {
self.inner.make_current_surfaceless()
}
}

impl GlContext for PossiblyCurrentContext {
Expand Down
27 changes: 9 additions & 18 deletions glutin/src/api/glx/context.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -241,15 +241,6 @@ pub struct NotCurrentContext {
}

impl NotCurrentContext {
/// Make a [`Self::PossiblyCurrentContext`] indicating that the context
/// could be current on the thread.
///
/// Requires the GLX_ARB_create_context extension and OpenGL 3.0 or greater.
pub fn make_current_surfaceless(self) -> Result<PossiblyCurrentContext> {
self.inner.make_current_surfaceless()?;
Ok(PossiblyCurrentContext { inner: self.inner, _nosendsync: PhantomData })
}

fn new(inner: ContextInner) -> Self {
Self { inner }
}
Expand Down Expand Up @@ -279,6 +270,11 @@ impl NotCurrentGlContext for NotCurrentContext {
self.inner.make_current_draw_read(surface_draw, surface_read)?;
Ok(PossiblyCurrentContext { inner: self.inner, _nosendsync: PhantomData })
}

fn make_current_surfaceless(self) -> Result<PossiblyCurrentContext> {
self.inner.make_current_surfaceless()?;
Ok(PossiblyCurrentContext { inner: self.inner, _nosendsync: PhantomData })
}
}

impl GlContext for NotCurrentContext {
Expand Down Expand Up @@ -319,15 +315,6 @@ pub struct PossiblyCurrentContext {
_nosendsync: PhantomData<GLXContext>,
}

impl PossiblyCurrentContext {
/// Make this context current on the calling thread.
///
/// Requires the GLX_ARB_create_context extension and OpenGL 3.0 or greater.
pub fn make_current_surfaceless(&self) -> Result<()> {
self.inner.make_current_surfaceless()
}
}

impl PossiblyCurrentGlContext for PossiblyCurrentContext {
type NotCurrentContext = NotCurrentContext;
type Surface<T: SurfaceTypeTrait> = Surface<T>;
Expand Down Expand Up @@ -356,6 +343,10 @@ impl PossiblyCurrentGlContext for PossiblyCurrentContext {
) -> Result<()> {
self.inner.make_current_draw_read(surface_draw, surface_read)
}

fn make_current_surfaceless(&self) -> Result<()> {
self.inner.make_current_surfaceless()
}
}

impl GlContext for PossiblyCurrentContext {
Expand Down
27 changes: 9 additions & 18 deletions glutin/src/api/wgl/context.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -232,15 +232,6 @@ impl NotCurrentContext {
fn new(inner: ContextInner) -> Self {
Self { inner }
}

/// Make a [`Self::PossiblyCurrentContext`] indicating that the context
/// could be current on the thread.
///
/// Requires the WGL_ARB_create_context extension and OpenGL 3.0 or greater.
pub fn make_current_surfaceless(self) -> Result<PossiblyCurrentContext> {
self.inner.make_current_surfaceless()?;
Ok(PossiblyCurrentContext { inner: self.inner, _nosendsync: PhantomData })
}
}

impl NotCurrentGlContext for NotCurrentContext {
Expand All @@ -266,6 +257,11 @@ impl NotCurrentGlContext for NotCurrentContext {
) -> Result<Self::PossiblyCurrentContext> {
Err(self.inner.make_current_draw_read(surface_draw, surface_read).into())
}

fn make_current_surfaceless(self) -> Result<PossiblyCurrentContext> {
self.inner.make_current_surfaceless()?;
Ok(PossiblyCurrentContext { inner: self.inner, _nosendsync: PhantomData })
}
}

impl GlContext for NotCurrentContext {
Expand Down Expand Up @@ -304,15 +300,6 @@ pub struct PossiblyCurrentContext {
_nosendsync: PhantomData<HGLRC>,
}

impl PossiblyCurrentContext {
/// Make this context current on the calling thread.
///
/// Requires the WGL_ARB_create_context extension and OpenGL 3.0 or greater.
pub fn make_current_surfaceless(&self) -> Result<()> {
self.inner.make_current_surfaceless()
}
}

impl PossiblyCurrentGlContext for PossiblyCurrentContext {
type NotCurrentContext = NotCurrentContext;
type Surface<T: SurfaceTypeTrait> = Surface<T>;
Expand Down Expand Up @@ -349,6 +336,10 @@ impl PossiblyCurrentGlContext for PossiblyCurrentContext {
) -> Result<()> {
Err(self.inner.make_current_draw_read(surface_draw, surface_read).into())
}

fn make_current_surfaceless(&self) -> Result<()> {
self.inner.make_current_surfaceless()
}
}

impl Sealed for PossiblyCurrentContext {}
Expand Down
47 changes: 38 additions & 9 deletions glutin/src/context.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,9 @@ pub trait NotCurrentGlContext: Sealed {
/// guaranteed to be current.
fn treat_as_possibly_current(self) -> Self::PossiblyCurrentContext;

/// Make [`Self::Surface`] on the calling thread producing the
/// Make [`Self::Surface`] current on the calling thread producing the
/// [`Self::PossiblyCurrentContext`] indicating that the context could
/// be current on the thread.
/// be current on the calling thread.
///
/// # Platform specific
///
Expand All @@ -67,14 +67,24 @@ pub trait NotCurrentGlContext: Sealed {
/// The same as [`Self::make_current`], but provides a way to set read and
/// draw surfaces.
///
/// # Api-specific:
/// # Api specific
///
/// - **WGL/CGL:** not supported.
fn make_current_draw_read<T: SurfaceTypeTrait>(
self,
surface_draw: &Self::Surface<T>,
surface_read: &Self::Surface<T>,
) -> Result<Self::PossiblyCurrentContext>;

/// Make context current on the calling thread without a default
/// framebuffer producing the [`Self::PossiblyCurrentContext`] indicating
/// that the context could be current on the calling thread.
///
/// # Api specific
///
/// - **WGL/GLX:** requires OpenGL 3.0 or greater context and
/// ARB_create_context extensions.
fn make_current_surfaceless(self) -> Result<Self::PossiblyCurrentContext>;
}

/// A trait to group common context operations.
Expand Down Expand Up @@ -109,17 +119,26 @@ pub trait PossiblyCurrentGlContext: Sealed {
/// - **macOS: this will block if your main thread is blocked.**
fn make_current<T: SurfaceTypeTrait>(&self, surface: &Self::Surface<T>) -> Result<()>;

/// The same as [`Self::make_current`] but provides a way to set read and
/// The same as [`Self::make_current`], but provides a way to set read and
/// draw surfaces explicitly.
///
/// # Api-specific:
/// # Api specific
///
/// - **CGL/WGL:** not supported.
fn make_current_draw_read<T: SurfaceTypeTrait>(
&self,
surface_draw: &Self::Surface<T>,
surface_read: &Self::Surface<T>,
) -> Result<()>;

/// Make context current on the calling thread without a default
/// framebuffer.
///
/// # Api specific
///
/// - **WGL/GLX:** requires OpenGL 3.0 or greater context and
/// ARB_create_context extensions.
fn make_current_surfaceless(&self) -> Result<()>;
}

/// A trait that provides raw context.
Expand Down Expand Up @@ -156,7 +175,7 @@ impl ContextAttributesBuilder {
/// To get sharing working it's recommended to use the same [`Config`] when
/// creating contexts that are going to be shared.
///
/// # Platform-specific
/// # Platform specific
///
/// - **Wayland:** both contexts must use the same Wayland connection.
///
Expand Down Expand Up @@ -190,7 +209,7 @@ impl ContextAttributesBuilder {
///
/// By default the profile is unspecified.
///
/// # Api-specific
/// # Api specific
///
/// - **macOS:** not supported, the latest is picked automatically.
pub fn with_profile(mut self, profile: GlProfile) -> Self {
Expand All @@ -210,7 +229,7 @@ impl ContextAttributesBuilder {
///
/// The `raw_window_handle` isn't required and here for WGL compatibility.
///
/// # Api-specific
/// # Api specific
///
/// - **WGL:** you **must** pass a `raw_window_handle` if you plan to use
/// this context with that window.
Expand Down Expand Up @@ -338,7 +357,7 @@ pub enum ReleaseBehavior {
/// Doesn't do anything. Most notably doesn't flush. Not supported by all
/// drivers.
///
/// # Api-specific
/// # Api specific
///
/// - **macOS:** not supported, [`Self::Flush`] is always used.
None,
Expand Down Expand Up @@ -391,6 +410,12 @@ impl NotCurrentGlContext for NotCurrentContext {
gl_api_dispatch!(self; Self(context) => context.treat_as_possibly_current(); as PossiblyCurrentContext)
}

fn make_current_surfaceless(self) -> Result<PossiblyCurrentContext> {
Ok(
gl_api_dispatch!(self; Self(context) => context.make_current_surfaceless()?; as PossiblyCurrentContext),
)
}

fn make_current<T: SurfaceTypeTrait>(
self,
surface: &Self::Surface<T>,
Expand Down Expand Up @@ -522,6 +547,10 @@ impl PossiblyCurrentGlContext for PossiblyCurrentContext {
)
}

fn make_current_surfaceless(&self) -> Result<()> {
gl_api_dispatch!(self; Self(context) => context.make_current_surfaceless())
}

fn make_not_current_in_place(&self) -> Result<()> {
Ok(gl_api_dispatch!(self; Self(context) => context.make_not_current_in_place()?))
}
Expand Down

0 comments on commit c0b8350

Please sign in to comment.