| Safe Haskell | Safe |
|---|---|
| Language | Haskell2010 |
SDL.Video.OpenGL
Contents
Synopsis
- defaultOpenGL :: OpenGLConfig
- data OpenGLConfig = OpenGLConfig {}
- data GLContext
- glCreateContext :: (Functor m, MonadIO m) => Window -> m GLContext
- data Profile
- data Mode
- glMakeCurrent :: (Functor m, MonadIO m) => Window -> GLContext -> m ()
- glDeleteContext :: MonadIO m => GLContext -> m ()
- glGetDrawableSize :: MonadIO m => Window -> m (V2 CInt)
- glSwapWindow :: MonadIO m => Window -> m ()
- data SwapInterval
- swapInterval :: StateVar SwapInterval
- glGetProcAddress :: MonadIO m => CString -> m (Ptr ())
Creating and Configuring OpenGL Contexts
defaultOpenGL :: OpenGLConfig #
A set of default options for OpenGLConfig
defaultOpenGL=OpenGLConfig{glColorPrecision= V4 8 8 8 0 ,glDepthPrecision= 24 ,glStencilPrecision= 8 ,glMultisampleSamples= 1 ,glProfile=CompatibilityNormal2 1 }
data OpenGLConfig #
Configuration used when creating an OpenGL rendering context.
Constructors
| OpenGLConfig | |
Fields
| |
Instances
A created OpenGL context.
glCreateContext :: (Functor m, MonadIO m) => Window -> m GLContext #
Create a new OpenGL context and makes it the current context for the window.
Throws SDLException if the window wasn't configured with OpenGL
support, or if context creation fails.
See SDL_GL_CreateContext for C documentation.
The profile a driver should use when creating an OpenGL context.
Constructors
| Core Mode CInt CInt | Use the OpenGL core profile, with a given major and minor version |
| Compatibility Mode CInt CInt | Use the compatibilty profile with a given major and minor version. The compatibility profile allows you to use deprecated functions such as immediate mode |
| ES Mode CInt CInt | Use an OpenGL profile for embedded systems |
Instances
The mode a driver should use when creating an OpenGL context.
Constructors
| Normal | A normal profile with no special debugging support |
| Debug | Use a debug context, allowing the usage of extensions such as |
Instances
| Bounded Mode # | |
| Enum Mode # | |
| Eq Mode # | |
| Data Mode # | |
Defined in SDL.Video.OpenGL Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Mode -> c Mode # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Mode # dataTypeOf :: Mode -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Mode) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Mode) # gmapT :: (forall b. Data b => b -> b) -> Mode -> Mode # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Mode -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Mode -> r # gmapQ :: (forall d. Data d => d -> u) -> Mode -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Mode -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Mode -> m Mode # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Mode -> m Mode # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Mode -> m Mode # | |
| Ord Mode # | |
| Read Mode # | |
| Show Mode # | |
| Generic Mode # | |
| type Rep Mode # | |
glMakeCurrent :: (Functor m, MonadIO m) => Window -> GLContext -> m () #
Set up an OpenGL context for rendering into an OpenGL window.
Throws SDLException on failure.
See SDL_GL_MakeCurrent for C documentation.
glDeleteContext :: MonadIO m => GLContext -> m () #
Delete the given OpenGL context.
You must make sure that there are no pending commands in the OpenGL command queue, the driver may still be processing commands even if you have stopped issuing them!
The glFinish command will block until the command queue has been fully
processed. You should call that function before deleting a context.
See SDL_GL_DeleteContext for C documentation.
Querying for the drawable size without a Renderer
glGetDrawableSize :: MonadIO m => Window -> m (V2 CInt) #
Get the size of a window's underlying drawable area in pixels (for use with glViewport).
It may differ from windowSize if window was created with windowHighDPI flag.
Swapping
The process of "swapping" means to move the back-buffer into the window contents itself.
glSwapWindow :: MonadIO m => Window -> m () #
Replace the contents of the front buffer with the back buffer's. The
contents of the back buffer are undefined, clear them with glClear or
equivalent before drawing to them again.
See SDL_GL_SwapWindow for C documentation.
data SwapInterval #
The swap interval for the current OpenGL context.
Constructors
| ImmediateUpdates | No vertical retrace synchronization |
| SynchronizedUpdates | The buffer swap is synchronized with the vertical retrace |
| LateSwapTearing |
Instances
swapInterval :: StateVar SwapInterval #
Get or set the swap interval for the current OpenGL context.
This StateVar can be modified using $= and the current value retrieved with get.
See SDL_GL_SetSwapInterval and SDL_GL_GetSwapInterval for C documentation.
Function Loading
glGetProcAddress :: MonadIO m => CString -> m (Ptr ()) #