Magnum::GL::Renderer class

Public types

enum class PolygonFacing: GLenum { Front = GL_FRONT, Back = GL_BACK, FrontAndBack = GL_FRONT_AND_BACK }

Affected polygon facing for culling, stencil operations and masks.

Renderer features

enum class Feature: GLenum { BlendAdvancedCoherent = GL_BLEND_ADVANCED_COHERENT_KHR, Blending = GL_BLEND, DebugOutput = GL_DEBUG_OUTPUT, DebugOutputSynchronous = GL_DEBUG_OUTPUT_SYNCHRONOUS, DepthClamp = GL_DEPTH_CLAMP, DepthTest = GL_DEPTH_TEST, Dithering = GL_DITHER, FaceCulling = GL_CULL_FACE, FramebufferSRGB = GL_FRAMEBUFFER_SRGB, LogicOperation = GL_COLOR_LOGIC_OP, Multisampling = GL_MULTISAMPLE, PolygonOffsetFill = GL_POLYGON_OFFSET_FILL, PolygonOffsetLine = GL_POLYGON_OFFSET_LINE, PolygonOffsetPoint = GL_POLYGON_OFFSET_POINT, ProgramPointSize = GL_PROGRAM_POINT_SIZE, RasterizerDiscard = GL_RASTERIZER_DISCARD, ScissorTest = GL_SCISSOR_TEST, SeamlessCubeMapTexture = GL_TEXTURE_CUBE_MAP_SEAMLESS, StencilTest = GL_STENCIL_TEST }

Features.

enum class Hint: GLenum { FragmentShaderDerivative = GL_FRAGMENT_SHADER_DERIVATIVE_HINT, TextureCompression = GL_TEXTURE_COMPRESSION_HINT }

Hint.

enum class HintMode: GLenum { Fastest = GL_FASTEST, Nicest = GL_NICEST, DontCare = GL_DONT_CARE }

Hint mode.

static void enable(Feature feature)

Enable feature.

static void disable(Feature feature)

Disable feature.

static void setFeature(Feature feature, bool enabled)

Enable or disable feature.

static void setHint(Hint target, HintMode mode)

Set hint.

Clearing values

static void setClearColor(const Color4& color)

Set clear color.

static void setClearDepth(Double depth)

Set clear depth.

static void setClearDepth(Float depth)

static void setClearStencil(Int stencil)

Set clear stencil.

Polygon drawing settings

enum class FrontFace: GLenum { CounterClockWise = GL_CCW, ClockWise = GL_CW }

Front facing polygon winding.

enum class ProvokingVertex: GLenum { FirstVertexConvention = GL_FIRST_VERTEX_CONVENTION, LastVertexConvention = GL_LAST_VERTEX_CONVENTION }

Provoking vertex.

enum class PolygonMode: GLenum { Fill = GL_FILL, Line = GL_LINE, Point = GL_POINT }

Polygon mode.

static void setFrontFace(FrontFace mode)

Set front-facing polygon winding.

static void setFaceCullingMode(PolygonFacing mode)

Which polygon facing to cull.

static void setProvokingVertex(ProvokingVertex mode)

Set provoking vertex.

static void setPolygonMode(PolygonMode mode)

Set polygon drawing mode.

static void setPolygonOffset(Float factor, Float units)

Set polygon offset.

static void setLineWidth(Float width)

Set line width.

static void setPointSize(Float size)

Set point size.

Scissor operations

static void setScissor(const Range2Di& rectangle)

Set scissor rectangle.

Stencil operations

enum class StencilFunction: GLenum { Never = GL_NEVER, Always = GL_ALWAYS, Less = GL_LESS, LessOrEqual = GL_LEQUAL, Equal = GL_EQUAL, NotEqual = GL_NOTEQUAL, GreaterOrEqual = GL_GEQUAL, Greater = GL_GREATER }

Stencil function.

enum class StencilOperation: GLenum { Keep = GL_KEEP, Zero = GL_ZERO, Replace = GL_REPLACE, Increment = GL_INCR, IncrementWrap = GL_INCR_WRAP, Decrement = GL_DECR, DecrementWrap = GL_DECR_WRAP, Invert = GL_INVERT }

Stencil operation.

static void setStencilFunction(PolygonFacing facing, StencilFunction function, Int referenceValue, UnsignedInt mask)

Set stencil function.

static void setStencilFunction(StencilFunction function, Int referenceValue, UnsignedInt mask)

Set stencil function.

static void setStencilOperation(PolygonFacing facing, StencilOperation stencilFail, StencilOperation depthFail, StencilOperation depthPass)

Set stencil operation.

static void setStencilOperation(StencilOperation stencilFail, StencilOperation depthFail, StencilOperation depthPass)

Set stencil operation.

Depth testing

using DepthFunction = StencilFunction

Depth function.

static void setDepthFunction(DepthFunction function)

Set depth function.

Masking writes

static void setColorMask(GLboolean allowRed, GLboolean allowGreen, GLboolean allowBlue, GLboolean allowAlpha)

Mask color writes.

static void setDepthMask(GLboolean allow)

Mask depth writes.

static void setStencilMask(PolygonFacing facing, UnsignedInt allowBits)

Mask stencil writes.

static void setStencilMask(UnsignedInt allowBits)

Mask stencil writes.

Blending

You have to enable blending with enable() first.

enum class BlendEquation: GLenum { Add = GL_FUNC_ADD, Subtract = GL_FUNC_SUBTRACT, ReverseSubtract = GL_FUNC_REVERSE_SUBTRACT, Min = GL_MIN, Max = GL_MAX, Multiply = GL_MULTIPLY_KHR, Screen = GL_SCREEN_KHR, Overlay = GL_OVERLAY_KHR, Darken = GL_DARKEN_KHR, Lighten = GL_LIGHTEN_KHR, ColorDodge = GL_COLORDODGE_KHR, ColorBurn = GL_COLORBURN_KHR, HardLight = GL_HARDLIGHT_KHR, SoftLight = GL_SOFTLIGHT_KHR, Difference = GL_DIFFERENCE_KHR, Exclusion = GL_EXCLUSION_KHR, HslHue = GL_HSL_HUE_KHR, HslSaturation = GL_HSL_SATURATION_KHR, HslColor = GL_HSL_COLOR_KHR, HslLuminosity = GL_HSL_LUMINOSITY_KHR }

Blend equation.

enum class BlendFunction: GLenum { Zero = GL_ZERO, One = GL_ONE, ConstantColor = GL_CONSTANT_COLOR, OneMinusConstantColor = GL_ONE_MINUS_CONSTANT_COLOR, ConstantAlpha = GL_CONSTANT_ALPHA, OneMinusConstantAlpha = GL_ONE_MINUS_CONSTANT_ALPHA, SourceColor = GL_SRC_COLOR, SecondSourceColor = GL_SRC1_COLOR, OneMinusSourceColor = GL_ONE_MINUS_SRC_COLOR, OneMinusSecondSourceColor = GL_ONE_MINUS_SRC1_COLOR, SourceAlpha = GL_SRC_ALPHA, SourceAlphaSaturate = GL_SRC_ALPHA_SATURATE, SecondSourceAlpha = GL_SRC1_ALPHA, OneMinusSourceAlpha = GL_ONE_MINUS_SRC_ALPHA, OneMinusSecondSourceAlpha = GL_ONE_MINUS_SRC1_ALPHA, DestinationColor = GL_DST_COLOR, OneMinusDestinationColor = GL_ONE_MINUS_DST_COLOR, DestinationAlpha = GL_DST_ALPHA, OneMinusDestinationAlpha = GL_ONE_MINUS_DST_ALPHA }

Blend function.

static void setBlendEquation(BlendEquation equation)

Set blend equation.

static void setBlendEquation(BlendEquation rgb, BlendEquation alpha)

Set blend equation separately for RGB and alpha components.

static void setBlendFunction(BlendFunction source, BlendFunction destination)

Set blend function.

static void setBlendFunction(BlendFunction sourceRgb, BlendFunction destinationRgb, BlendFunction sourceAlpha, BlendFunction destinationAlpha)

Set blend function separately for RGB and alpha components.

static void setBlendColor(const Color4& color)

Set blend color.

static void blendBarrier()

Blend barrier.

Logical operation

enum class LogicOperation: GLenum { Clear = GL_CLEAR, Set = GL_SET, Copy = GL_COPY, CopyInverted = GL_COPY_INVERTED, Noop = GL_NOOP, Invert = GL_INVERT, And = GL_AND, AndReverse = GL_AND_REVERSE, AndInverted = GL_AND_INVERTED, Nand = GL_NAND, Or = GL_OR, OrReverse = GL_OR_REVERSE, OrInverted = GL_OR_INVERTED, Nor = GL_NOR, Xor = GL_XOR, Equivalence = GL_EQUIV }

Logical operation.

static void setLogicOperation(LogicOperation operation)

Set logical operation.

Renderer synchronization

enum class MemoryBarrier: GLbitfield { VertexAttributeArray = GL_VERTEX_ATTRIB_ARRAY_BARRIER_BIT, ElementArray = GL_ELEMENT_ARRAY_BARRIER_BIT, Uniform = GL_UNIFORM_BARRIER_BIT, TextureFetch = GL_TEXTURE_FETCH_BARRIER_BIT, ShaderImageAccess = GL_SHADER_IMAGE_ACCESS_BARRIER_BIT, Command = GL_COMMAND_BARRIER_BIT, PixelBuffer = GL_PIXEL_BUFFER_BARRIER_BIT, TextureUpdate = GL_TEXTURE_UPDATE_BARRIER_BIT, BufferUpdate = GL_BUFFER_UPDATE_BARRIER_BIT, Framebuffer = GL_FRAMEBUFFER_BARRIER_BIT, TransformFeedback = GL_TRANSFORM_FEEDBACK_BARRIER_BIT, AtomicCounter = GL_ATOMIC_COUNTER_BARRIER_BIT, ShaderStorage = GL_ATOMIC_COUNTER_BARRIER_BIT }

Memory barrier.

using MemoryBarriers = Containers::EnumSet<MemoryBarrier>

Memory barriers.

static void flush()

Flush the pipeline.

static void finish()

Finish the pipeline.

static void setMemoryBarrier(MemoryBarriers barriers)

Set memory barrier.

static void setMemoryBarrierByRegion(MemoryBarriers barriers)

Set memory barrier by region.

static void setTextureBarrier()

Set texture barrier.

Renderer management

enum class Error: GLenum { NoError = GL_NO_ERROR, InvalidEnum = GL_INVALID_ENUM, InvalidValue = GL_INVALID_VALUE, InvalidOperation = GL_INVALID_OPERATION, InvalidFramebufferOperation = GL_INVALID_FRAMEBUFFER_OPERATION, OutOfMemory = GL_OUT_OF_MEMORY, StackUnderflow = GL_STACK_UNDERFLOW, StackOverflow = GL_STACK_OVERFLOW }

Error status.

enum class ResetNotificationStrategy: GLint { NoResetNotification = GL_NO_RESET_NOTIFICATION_ARB, LoseContextOnReset = GL_LOSE_CONTEXT_ON_RESET_ARB }

Graphics reset notification strategy.

enum class GraphicsResetStatus: GLenum { NoError = GL_NO_ERROR, GuiltyContextReset = GL_GUILTY_CONTEXT_RESET_ARB, InnocentContextReset = GL_INNOCENT_CONTEXT_RESET_ARB, UnknownContextReset = GL_UNKNOWN_CONTEXT_RESET_ARB }

Graphics reset status.

static auto error() -> Error

Error status.

static auto resetNotificationStrategy() -> ResetNotificationStrategy

Graphics reset notification strategy.

static auto graphicsResetStatus() -> GraphicsResetStatus

Check graphics reset status.

Related

auto operator<<(Debug& debug, Renderer::Error value) -> Debug&

Debug output operator.

auto operator<<(Debug& debug, Renderer::ResetNotificationStrategy value) -> Debug&

Debug output operator.

auto operator<<(Debug& debug, Renderer::GraphicsResetStatus value) -> Debug&

Debug output operator.

Enum documentation

Typedef documentation

Function documentation

enabled ? Renderer::enable(feature) : Renderer::disable(feature)