opengles-0.8.3: Functional interface for OpenGL 4.1+ and OpenGL ES 2.0+

Safe Haskell	None
Language	Haskell2010

Graphics.EGL

Contents

EGL Lifecycle
Posting the Color Buffer
Query Context
Attributes
- Config Attributes
Surface
- Surface Attributes
Context
- Context Attributes
Synchronization Primitives
Copying Surface to Texture
Switching between APIs

Description

EGL 1.5 carefully reconstructed. EGL is an interface works between native window systems and rendering APIs such as OpenGL, OpenGL ES, OpenVG. This high-level APIs are specialized for OpenGL ES, so that initialization could be simply done in several lines. You can still access the rest of C APIs via Graphics.EGL.Base.

Synopsis

EGL Lifecycle

eglInit :: IO Egl Source

Initialize EGL with default display.

eglInitializeOn Source

Arguments

:: Maybe EGLNativeDisplay	If any, specify native display pointer.
-> [[(EGLConfAttr, Int32)]]	EGL configurations with many fallbacks.
-> [(EGLContextAttr, Int32)]	Choose GL version here.
-> IO Egl

Initialize EGL with specified display and configurations.

eglResume Source

Arguments

:: Egl
-> EGLNativeWindow	Pointer to the native window handler.
-> IO ()

Start using graphics APIs on this thread. initialization is performed here whenever necessary. EGL context would be re-created if the last context was lost due to power management events such as sleep.

eglSuspend :: Egl -> IO () Source

Stop using graphics APIs on this thread. Should be called before a sleep.

eglInvalidate :: Egl -> IO () Source

Invalidate EGL objects and terminates the display on this thread. You can still reuse Egl because Egl is state manager.

Posting the Color Buffer

eglPostFrame :: Egl -> IO () Source

Post EGL surface color buffer to the native window. eglPostFrame calls eglSwapBuffers inside.

eglPostInterval :: Egl -> Int32 -> IO Bool Source

Specifies the minimum number of video frame periods per buffer swap for the window associated with the current context. Returns False on failure. The default swap interval is 1.

Query Context

eglVendor :: Egl -> IO String Source

eglVersion :: Egl -> IO String Source

eglExtensions :: Egl -> IO [String] Source

eglClientAPIs :: Egl -> IO [String] Source

eglScreenDims :: Num a => Egl -> IO (a, a) Source

Attributes

egl_True :: EGLint Source

egl_False :: EGLint Source

egl_None :: EGLint Source

egl_DontCare :: EGLint Source

Config Attributes

egl_BufferSize :: EGLConfAttr Source

egl_AlphaSize :: EGLConfAttr Source

egl_BlueSize :: EGLConfAttr Source

egl_GreenSize :: EGLConfAttr Source

egl_RedSize :: EGLConfAttr Source

egl_DepthSize :: EGLConfAttr Source

egl_StencilSize :: EGLConfAttr Source

egl_ConfigCaveat :: EGLConfAttr Source

One of egl_None, egl_SlowConfig, egl_NonConformantConfig.

egl_ConfigID :: EGLConfAttr Source

egl_Level :: EGLConfAttr Source

egl_MaxPbufferHeight :: EGLConfAttr Source

egl_MaxPbufferPixels :: EGLConfAttr Source

egl_MaxPbufferWidth :: EGLConfAttr Source

egl_NativeRenderable :: EGLConfAttr Source

egl_NativeVisualID :: EGLConfAttr Source

egl_NativeVisualType :: EGLConfAttr Source

egl_Samples :: EGLConfAttr Source

egl_SampleBuffers :: EGLConfAttr Source

egl_SurfaceType :: EGLConfAttr Source

Bitmask, see below.

egl_TransparentType :: EGLConfAttr Source

egl_None or egl_TransparentRgb.

egl_TransparentBlueValue :: EGLConfAttr Source

egl_TransparentGreenValue :: EGLConfAttr Source

egl_TransparentRedValue :: EGLConfAttr Source

egl_BindToTextureRGB :: EGLConfAttr Source

egl_BindToTextureRGBA :: EGLConfAttr Source

egl_MinSwapInterval :: EGLConfAttr Source

egl_MaxSwapInterval :: EGLConfAttr Source

egl_LuminanceSize :: EGLConfAttr Source

egl_AlphaMaskSize :: EGLConfAttr Source

egl_ColorBufferType :: EGLConfAttr Source

egl_RgbBuffer or egl_LuminanceBuffer.

egl_RenderableType :: EGLConfAttr Source

Bitmask, see below.

egl_MatchNativePixmap :: EGLConfAttr Source

egl_Conformant :: EGLConfAttr Source

egl_ConfigCaveat values (except egl_None)

egl_SlowConfig :: EGLint Source

egl_NonConformantConfig :: EGLint Source

egl_SurfaceType mask bits

egl_PBuffer :: EGLint Source

egl_Pixmap :: EGLint Source

egl_Window :: EGLint Source

egl_VGColorspaceLinear :: EGLint Source

egl_VGAlphaFormatPre :: EGLint Source

egl_MultisampleResolveBox :: EGLint Source

egl_SwapBehaviorPreserved :: EGLint Source

egl_TransparentType values (except egl_None)

egl_TransparentRgb :: EGLint Source

egl_ColorBufferType values

egl_RgbBuffer :: EGLint Source

egl_LuminanceBuffer :: EGLint Source

egl_RenderableType bitmask

egl_OpenGLES :: EGLint Source

egl_OpenVG :: EGLint Source

egl_OpenGLES2 :: EGLint Source

egl_OpenGL :: EGLint Source

egl_OpenGLES3 :: EGLint Source

EGL_KHR_create_context or EGL 1.5 required

Surface

eglGetSurfaceAttr :: Egl -> EGLSurfAttr -> IO Int32 Source

eglSetSurfaceAttr :: Egl -> EGLSurfAttr -> Int32 -> IO Bool Source

Surface Attributes

egl_Height :: EGLSurfAttr Source

int Height of surface.

egl_Width :: EGLSurfAttr Source

int Width of surface.

egl_LargestPbuffer :: EGLSurfAttr Source

boolean If true, create largest pbuffer possible.

egl_TextureFormat :: EGLSurfAttr Source

enum Format of texture: RGB, RGBA, or no texture.

egl_TextureTarget :: EGLSurfAttr Source

enum Type of texture: 2D or no texture.

egl_MipmapTexture :: EGLSurfAttr Source

boolean True if texture has mipmaps.

egl_MipmapLevel :: EGLSurfAttr Source

int Mipmap level to render to.

egl_RenderBuffer :: EGLSurfAttr Source

enum Render buffer, see below.

egl_VGColorspace :: EGLSurfAttr Source

enum Color space for OpenVG, see below.

egl_VGAlphaFormat :: EGLSurfAttr Source

enum Alpha format for OpenVG, see below.

egl_HorizontalResolution :: EGLSurfAttr Source

int Horizontal dot pitch.

egl_VerticalResolution :: EGLSurfAttr Source

int Vertical dot pitch.

egl_PixelAspectRaito :: EGLSurfAttr Source

int Display aspect ratio.

egl_SwapBehavior :: EGLSurfAttr Source

enum Buffer swap behavior, see below.

egl_MultisampleResolve :: EGLSurfAttr Source

enum Multisample resolve behavior, see below.

egl_ConfigId :: EGLSurfAttr Source

int ID of EGLConfig surface was created with egl_Height integer Height of surface.

egl_GLColorspace :: EGLSurfAttr Source

EGL_KHR_gl_colorspace or EGL 1.5+ enum Color space for OpenGL, see below.

egl_Texture{Format,Target} values

egl_NoTexture :: EGLint Source

egl_TextureRgb :: EGLint Source

egl_TextureRgba :: EGLint Source

egl_Texture2D :: EGLint Source

egl_RenderBuffer values

egl_BackBuffer :: EGLint Source

egl_SingleBuffer :: EGLint Source

egl_{VG,GL}Colorspace values

egl_ColorspaceSrgb :: EGLint Source

egl_ColorspaceLinear :: EGLint Source

egl_VGAlphaFormat values

egl_Nonpre :: EGLint Source

egl_Pre :: EGLint Source

Resolution and Aspect Raito values

egl_DisplayScaling :: EGLint Source

Constant scale factor by which fractional display resolutions & aspect ratio are scaled when queried as integer values.

egl_Unknown :: EGLint Source

Unknown display resolution or aspect ratio.

egl_SwapBehavior values

egl_BufferPreserved :: EGLint Source

egl_BufferDestroyed :: EGLint Source

egl_MultisampleResolve values

egl_ResolveDefault :: EGLint Source

egl_ResolveBox :: EGLint Source

Context

eglConfigID :: Egl -> IO Int32 Source

eglContextClientType :: Egl -> IO Int32 Source

eglContextClientVersion :: Egl -> IO Int32 Source

eglRenderBuffer :: Egl -> IO Int32 Source

Context Attributes

egl_ClientVersion :: EGLContextAttr Source

Specify context client major version, 2 or later.

egl_GLRobustAccessExt :: EGLContextAttr Source

EGL_EXT_create_context_robustness required Same as unpostfixed version.

egl_GLResetNotificationStrategyExt :: EGLContextAttr Source

EGL_EXT_create_context_robustness required Same as unpostfixed version.

egl_MinorVersion :: EGLContextAttr Source

EGL_KHR_create_context or EGL 1.5 required Specify context client minor version.

egl_GLProfileMask :: EGLContextAttr Source

EGL_KHR_create_context or EGL 1.5 required See below.

egl_GLResetNotificationStrategy :: EGLContextAttr Source

EGL_KHR_create_context or EGL 1.5 required See below.

egl_ContextFlags :: EGLContextAttr Source

EGL_KHR_create_context required See below.

egl_GLDebug :: EGLContextAttr Source

EGL 1.5 required Specify egl_True or egl_False

egl_GLForwardCompat :: EGLContextAttr Source

EGL 1.5 required Specify egl_True or egl_False

egl_GLRobustAccess :: EGLContextAttr Source

EGL 1.5 required Specify egl_True or egl_False

egl_OpenGLProfileMask mask bits

egl_GLCoreProfileBit :: EGLint Source

egl_GLCompatProfileBit :: EGLint Source

egl_OpenGLResetNotificationStrategy values

egl_NoResetNotification :: EGLint Source

egl_LoseContextOnReset :: EGLint Source

egl_ContextFlags bits

egl_GLDebugBit :: EGLint Source

egl_GLForwardCompatBit :: EGLint Source

egl_GLRobustAccessBit :: EGLint Source

Synchronization Primitives

eglWaitCaller :: IO Bool Source

eglWaitGPU :: IO Bool Source

Copying Surface to Texture

type EGLBuffer = EGLint Source

Specify egl_RenderBuffer value. (Perhaps egl_BackBuffer only?)

eglBindAsTexture :: Egl -> EGLBuffer -> IO Bool Source

eglReleaseTexture :: Egl -> EGLBuffer -> IO Bool Source

Switching between APIs

newtype GraphicsAPI Source

Constructors

GraphicsAPI EGLenum

Instances

Show GraphicsAPI Source

pattern OpenGLES :: GraphicsAPI Source

pattern OpenVG :: GraphicsAPI Source

pattern OpenGL :: GraphicsAPI Source

eglBindCurrentAPI :: GraphicsAPI -> IO Bool Source

eglCurrentAPI :: IO GraphicsAPI Source