Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > OpenGLDrv

Light Theme

Dark Theme

OpenGLDrv

Windows

MacOS

Linux

Classes

	Name	Description
	FOpenGL3
	FOpenGL4
	FOpenGLAssertRHIThreadFence
	FOpenGLBase	Base static class.
	FOpenGLBaseIndexBuffer
	FOpenGLBasePixelBuffer
	FOpenGLBaseStructuredBuffer
	FOpenGLBaseTexture2D
	FOpenGLBaseTexture2DArray
	FOpenGLBaseTexture3D
	FOpenGLBaseTextureCube
	FOpenGLBaseVertexBuffer
	FOpenGLBindlessSamplerInfo
	FOpenGLBlendState
	FOpenGLBlendStateData
	FOpenGLBoundShaderState	Combined shader state and vertex definition for rendering geometry.
	FOpenGLBufferedGPUTiming	This class has multiple inheritance but really FGPUTiming is a static class.
	FOpenGLCachedAttr
	FOpenGLCodeHeader	Code header information.
	FOpenGLCommonState
	FOpenGLComputeShader
	FOpenGLContextState
	FOpenGLDepthStencilState
	FOpenGLDepthStencilStateData
	FOpenGLDisjointTimeStampQuery	Used to track whether a period was disjoint on the GPU, which means GPU timings are invalid.
	FOpenGLDynamicRHI	The interface which is implemented by the dynamically bound RHI.
	FOpenGLDynamicRHIModule	Implements the OpenGLDrv module as a dynamic RHI providing module.
	FOpenGLES
	FOpenGLEUniformBufferData
	FOpenGLEventNode	A single perf event node, which tracks information about a appBeginDrawEvent/appEndDrawEvent range.
	FOpenGLEventNodeFrame	An entire frame of perf event nodes, including ancillary timers.
	FOpenGLEventQuery	A OpenGL event query resource.
	FOpenGLGPUFence	Note that Poll() and WriteInternal() will stall the RHI thread if one is present.
	FOpenGLGPUProfiler	Encapsulates GPU profiling logic and data.
	FOpenGLLinkedProgramConfiguration
	FOpenGLProgramBinaryCache
	FOpenGLProgramKey	Unique identifier for a program. (composite of shader keys)
	FOpenGLRasterizerState
	FOpenGLRasterizerStateData
	FOpenGLRenderQuery
	FOpenGLRHIState
	FOpenGLRHIThreadResourceFence
	FOpenGLSamplerState
	FOpenGLSamplerStateData
	FOpenGLShaderBindings	Shader binding information.
	FOpenGLShaderDeviceCapabilities	GL device capabilities for generating GLSL compilable on platform with described capabilities
	FOpenGLShaderParameterCache	Caching of OpenGL uniform parameters.
	FOpenGLShaderResourceTable
	FOpenGLShaderResourceView
	FOpenGLShaderResourceViewProxy	This class is required to remove the SRV from the shader cache upon deletion
	FOpenGLShaderVarying
	FOpenGLStagingBuffer
	FOpenGLStream
	FOpenGLStructuredBufferUnorderedAccessView
	FOpenGLTextureBase
	FOpenGLTextureReference
	FOpenGLTextureUnorderedAccessView
	FOpenGLUniformBuffer
	FOpenGLUnorderedAccessView
	FOpenGLVertexBufferUnorderedAccessView
	FOpenGLVertexDeclaration	This represents a vertex declaration that hasn't been combined with a specific shader to create a bound shader.
	FOpenGLVertexElement
	FOpenGLViewport
	FRHICommandGLCommand
	FRHICommandGLCommandString
	FTextureStage
	FUAVStage
	TIsGLProxyObject
	TIsGLResourceWithFence
	TOpenGLBuffer
	TOpenGLResourceProxy
	TOpenGLResourceTraits
	TOpenGLShader	OpenGL shader resource.
	TOpenGLStreamedBufferArray
	TOpenGLTexture	Textures.

Constants

Name	Description
OGL_FIRST_UNIFORM_BUFFER	Shader related constants.
OGL_MAX_UNIFORM_BUFFER_BINDINGS	Shader related constants.
OGL_UAV_NOT_SUPPORTED_FOR_GRAPHICS_UNIT	Shader related constants.

Typedefs

Name	Description
a
attachment
b
baseViewIndex
BufferBindFunction
bufSize
depth
dstLevel
dstName
dstTarget
dstX
dstY
dstZ
FAnsiCharArray	For platform extensions: from OpenGLResources.h
FAnsiCharArray
FOpenGLComputeShaderProxy
FOpenGLDomainShader
FOpenGLDomainShaderProxy
FOpenGLEUniformBufferDataRef
FOpenGLGeometryShader
FOpenGLGeometryShaderProxy
FOpenGLHullShader
FOpenGLHullShaderProxy
FOpenGLIndexBuffer
FOpenGLPixelBuffer
FOpenGLPixelShader
FOpenGLPixelShaderProxy
FOpenGLStreamedIndexBufferArray
FOpenGLStreamedVertexBufferArray
FOpenGLStructuredBuffer
FOpenGLTexture
FOpenGLTexture2D
FOpenGLTexture2DArray
FOpenGLTexture3D
FOpenGLTextureCube
FOpenGLVertexBuffer
FOpenGLVertexElements	Convenience typedef: preallocated array of OpenGL input element descriptions.
FOpenGLVertexShader
FOpenGLVertexShaderProxy
g
GLdouble
height
id
ids
internalformat
label
layer
length
level
levels
marker
numViews
object
params
PFNGLMAPBUFFEROESPROC
pname
r
samples
srcLevel
srcTarget
srcX
srcY
srcZ
target
textarget
texture
UGLsync
width

Enums

	Name	Description
	EOpenGLShaderTargetPlatform

Functions

	Name	Description
void	CachedBindArrayBuffer ( GLuint Buffer )
void	CachedBindElementArrayBuffer ( GLuint Buffer )
void	CachedBindPixelUnpackBuffer ( GLuint Buffer )
void	CachedBindUniformBuffer ( GLuint Buffer )
TEnableIf<&#...	CheckRHITFence ( T* Resource )
TEnableIf< T...	CheckRHITFence ( T* Resource )
void	DecrementBufferMemory ( GLenum Type, bool bStructuredBuffer, uint32 NumBytes )
void	GetCurrentOpenGLShaderDeviceCapabilities ( FOpenGLShaderDeviceCapabilities& C... )	Gets the GL device capabilities for the current device.
GLenum	GetOpenGLCubeFace ( ECubeFace Face )	Convert from ECubeFace to GLenum type
GLenum	GetOpenGLTargetFromRHITexture ( FRHITexture* Texture )
FOpenGLTextu...	GetOpenGLTextureFromRHITexture ( FRHITexture* Texture )	Given a pointer to a RHI texture that was created by the OpenGL RHI, returns a pointer to the FOpenGLTextureBase it encapsulates.
uint32	GetOpenGLTextureSizeXFromRHITexture ( FRHITexture* Texture )
uint32	GetOpenGLTextureSizeYFromRHITexture ( FRHITexture* Texture )
uint32	GetOpenGLTextureSizeZFromRHITexture ( FRHITexture* Texture )
typedef	GLboolean ( GL_APIENTRYP PFNGLUNMAPBUFFEROESPRO... )
void	GLSLToDeviceCompatibleGLSL ( FAnsiCharArray& GlslCodeOriginal, const FString& ShaderName, GLenum TypeEnum, const FOpenGLShaderDeviceCapabiliti..., FAnsiCharArray& GlslCode )	Processes the GLSL output of the shader cross compiler to get GLSL that can be compiled on a platform with the specified capabilities.
void	IncrementBufferMemory ( GLenum Type, bool bStructuredBuffer, uint32 NumBytes )
bool	IsUniformBufferBound ( GLuint Buffer )
void	OnIndexBufferDeletion ( GLuint IndexBufferResource )
void	OnPixelBufferDeletion ( GLuint PixelBufferResource )
void	OnProgramDeletion ( GLint ProgramResource )
void	OnUniformBufferDeletion ( GLuint UniformBufferResource, uint32 AllocatedSize, bool bStreamDraw, uint32 Offset, uint8* Pointer )
void	OnVertexBufferDeletion ( GLuint VertexBufferResource )
void	OpenGLTextureAllocated ( FRHITexture* Texture, uint32 Flags )
void	OpenGLTextureDeleted ( FRHITexture* Texture )
void	PE_AppendCString ( TArray< ANSICHAR >& Dest, const ANSICHAR* Source )	Make some anon ns functions available to platform extensions
void	PE_ReplaceCString ( TArray< ANSICHAR >& Dest, const ANSICHAR* Source, const ANSICHAR* Replacement )
bool	PlatformOpenGLContextValid()	Returns true, if current thread has a valid OpenGL context selected, false otherwise.
void	ReleaseOpenGLFramebuffers ( FOpenGLDynamicRHI* Device, FRHITexture* TextureRHI )
void	RunOnGLRenderContextThread ( TFunction< void)> GLFunc, bool bWaitForCompletion )
bool	ShouldRunGLRenderContextOpOnThisThread ( FRHICommandListImmediate& RHICmdLi... )
typedef	void ( GL_APIENTRYP PFNGLGENQUERIESEXTPROC )	Mobile multi-view.

Variables

		Name	Description
	PFNGLBEGINQUERY...	glBeginQueryEXT
	PFNGLBINDBUFFER...	glBindBufferBase
	PFNGLBINDBUFFER...	glBindBufferRange
	PFNGLBINDIMAGET...	glBindImageTexture
	PFNGLBINDSAMPLE...	glBindSampler
	PFNGLBINDVERTEX...	glBindVertexArray
	PFNGLBLITFRAMEB...	glBlitFramebuffer
	PFNGLCLEARBUFFE...	glClearBufferfi
	PFNGLCLEARBUFFE...	glClearBufferfv
	PFNGLCLEARBUFFE...	glClearBufferiv
	PFNGLCLEARBUFFE...	glClearBufferuiv
	PFNGLCLIENTWAIT...	glClientWaitSync
	PFNGLCOLORMASKI...	glColorMaskiEXT
	PFNGLCOMPRESSED...	glCompressedTexImage3D
	PFNGLCOMPRESSED...	glCompressedTexSubImage3D
	PFNGLCOPYBUFFER...	glCopyBufferSubData
	PFNGLCOPYIMAGES...	glCopyImageSubData
	PFNGLCOPYTEXSUB...	glCopyTexSubImage3D
	PFNGLDEBUGMESSA...	glDebugMessageCallbackKHR
	PFNGLDEBUGMESSA...	glDebugMessageControlKHR
	PFNGLDEBUGMESSA...	glDebugMessageInsertKHR
	PFNGLGETDEBUGME...	glDebugMessageLogKHR
	PFNGLDELETEQUER...	glDeleteQueriesEXT
	PFNGLDELETESAMP...	glDeleteSamplers
	PFNGLDELETESYNC...	glDeleteSync
	PFNGLDISCARDFRA...	glDiscardFramebufferEXT
	PFNGLDISPATCHCO...	glDispatchCompute
	PFNGLDISPATCHCO...	glDispatchComputeIndirect
	PFNGLDRAWARRAYS...	glDrawArraysIndirect
	PFNGLDRAWARRAYS...	glDrawArraysInstanced
	PFNGLDRAWBUFFER...	glDrawBuffers
	PFNGLDRAWELEMEN...	glDrawElementsIndirect
	PFNGLDRAWELEMEN...	glDrawElementsInstanced
	PFNGLENDQUERYEX...	glEndQueryEXT
	PFNGLFENCESYNCP...	glFenceSync
	PFNGLFRAMEBUFFE...	glFramebufferTexture2DMultisampleEXT
	PFNGLFRAMEBUFFE...	glFramebufferTextureLayer
	PFNGLFRAMEBUFFE...	glFramebufferTextureMultisampleMultiviewOVR
	PFNGLFRAMEBUFFE...	glFramebufferTextureMultiviewOVR
	PFNGLGENQUERIES...	glGenQueriesEXT
	PFNGLGENSAMPLER...	glGenSamplers
	PFNGLGENVERTEXA...	glGenVertexArrays
	PFNGLGETOBJECTL...	glGetObjectLabelEXT
	PFNGLGETOBJECTL...	glGetObjectLabelKHR
	PFNGLGETOBJECTP...	glGetObjectPtrLabelKHR
	PFNGLGETPOINTER...	glGetPointervKHR
	PFNGLGETPROGRAM...	glGetProgramBinary
	PFNGLGETQUERYIV...	glGetQueryivEXT
	PFNGLGETQUERYOB...	glGetQueryObjectui64vEXT
	PFNGLGETQUERYOB...	glGetQueryObjectuivEXT
	PFNGLGETUNIFORM...	glGetUniformBlockIndex
	PFNGLISQUERYEXT...	glIsQueryEXT
	PFNGLISSYNCPROC	glIsSync
	PFNGLLABELOBJEC...	glLabelObjectEXT
	PFNGLMAPBUFFERO...	glMapBufferOESa
	PFNGLMAPBUFFERR...	glMapBufferRange
	PFNGLMEMORYBARR...	glMemoryBarrier
	PFNGLOBJECTLABE...	glObjectLabelKHR
	PFNGLOBJECTPTRL...	glObjectPtrLabelKHR
	PFNGLPOPDEBUGGR...	glPopDebugGroupKHR
	PFNGLPOPGROUPMA...	glPopGroupMarkerEXT
	PFNGLPROGRAMBIN...	glProgramBinary
	PFNGLPROGRAMPAR...	glProgramParameteri
	PFNGLPUSHDEBUGG...	glPushDebugGroupKHR
	PFNGLPUSHGROUPM...	glPushGroupMarkerEXT
	PFNGLQUERYCOUNT...	glQueryCounterEXT
	PFNGLREADBUFFER...	glReadBuffer
	PFNGLRENDERBUFF...	glRenderbufferStorageMultisampleEXT
	PFNGLSAMPLERPAR...	glSamplerParameteri
	PFNGLTEXBUFFERE...	glTexBufferEXT
	PFNGLTEXBUFFERR...	glTexBufferRangeEXT
	PFNGLTEXIMAGE3D...	glTexImage3D
	PFNGLTEXSTORAGE...	glTexStorage2D
	PFNGLTEXSTORAGE...	glTexStorage3D
	PFNGLTEXSUBIMAG...	glTexSubImage3D
	PFNGLUNIFORM4UI...	glUniform4uiv
	PFNGLUNIFORMBLO...	glUniformBlockBinding
	PFNGLUNMAPBUFFE...	glUnmapBuffer
	PFNGLUNMAPBUFFE...	glUnmapBufferOESa
	PFNGLVERTEXATTR...	glVertexAttribDivisor
	PFNGLVERTEXATTR...	glVertexAttribIPointer
	ERHIFeatureLeve...	GRequestedFeatureLevel

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss