Interface to driver which is able to perform 2d and 3d graphics functions. More...

#include <IVideoDriver.h>

Inheritance diagram for irr::video::IVideoDriver:

Classes
struct	SShaderConstant

Public Types
enum	E_SHADER_VAR_TYPE { ESVT_INT32 = 0, ESVT_FLOAT32, ESVT_VEC2, ESVT_VEC3, ESVT_VEC4, ESVT_MAT4, ESVT_COUNT }

Public Member Functions
virtual bool	beginScene (u16 clearFlag=(u16)(ECBF_COLOR\|ECBF_DEPTH), SColor clearColor=SColor(255, 0, 0, 0), f32 clearDepth=1.f, u8 clearStencil=0, const SExposedVideoData &videoData=SExposedVideoData(), core::rect< s32 > *sourceRect=0)=0
	Applications must call this method before performing any rendering. More...

bool	beginScene (bool backBuffer, bool zBuffer, SColor color=SColor(255, 0, 0, 0), const SExposedVideoData &videoData=SExposedVideoData(), core::rect< s32 > *sourceRect=0)
	Alternative beginScene implementation. Can't clear stencil buffer, but otherwise identical to other beginScene. More...

virtual bool	endScene ()=0
	Presents the rendered image to the screen. More...

virtual bool	queryFeature (E_VIDEO_DRIVER_FEATURE feature) const =0
	Queries the features of the driver. More...

virtual void	disableFeature (E_VIDEO_DRIVER_FEATURE feature, bool flag=true)=0
	Disable a feature of the driver. More...

virtual const io::IAttributes &	getDriverAttributes () const =0
	Get attributes of the actual video driver. More...

virtual bool	checkDriverReset ()=0
	Check if the driver was recently reset. More...

virtual void	setTransform (E_TRANSFORMATION_STATE state, const core::matrix4 &mat)=0
	Sets transformation matrices. More...

virtual const core::matrix4 &	getTransform (E_TRANSFORMATION_STATE state) const =0
	Returns the transformation set by setTransform. More...

virtual u32	getImageLoaderCount () const =0
	Retrieve the number of image loaders. More...

virtual IImageLoader *	getImageLoader (u32 n)=0
	Retrieve the given image loader. More...

virtual u32	getImageWriterCount () const =0
	Retrieve the number of image writers. More...

virtual IImageWriter *	getImageWriter (u32 n)=0
	Retrieve the given image writer. More...

virtual void	setMaterial (const SMaterial &material)=0
	Sets a material. More...

virtual ITexture *	getTexture (const io::path &filename)=0
	Get access to a named texture. More...

virtual ITexture *	getTexture (io::IReadFile *file)=0
	Get access to a named texture. More...

virtual ITexture *	getTextureByIndex (u32 index)=0
	Returns a texture by index. More...

virtual u32	getTextureCount () const =0
	Returns amount of textures currently loaded. More...

virtual void	renameTexture (ITexture *texture, const io::path &newName)=0
	Renames a texture. More...

virtual ITexture *	addTexture (const core::dimension2d< u32 > &size, const io::path &name, ECOLOR_FORMAT format=ECF_A8R8G8B8)=0
	Creates an empty texture of specified size. More...

_IRR_DEPRECATED_ ITexture *	addTexture (const io::path &name, IImage image, void mipmapData)
	Creates a texture from an IImage. More...

virtual ITexture *	addTexture (const io::path &name, IImage *image)=0
	Creates a texture from an IImage. More...

virtual ITexture *	addTextureCubemap (const io::path &name, IImage imagePosX, IImage imageNegX, IImage imagePosY, IImage imageNegY, IImage imagePosZ, IImage imageNegZ)=0
	Creates a cubemap texture from loaded IImages. More...

virtual ITexture *	addTextureCubemap (const irr::u32 sideLen, const io::path &name, ECOLOR_FORMAT format=ECF_A8R8G8B8)=0
	Creates an empty cubemap texture of specified size. More...

virtual ITexture *	addRenderTargetTexture (const core::dimension2d< u32 > &size, const io::path &name="rt", const ECOLOR_FORMAT format=ECF_UNKNOWN)=0
	Adds a new render target texture to the texture cache. More...

virtual ITexture *	addRenderTargetTextureCubemap (const irr::u32 sideLen, const io::path &name="rt", const ECOLOR_FORMAT format=ECF_UNKNOWN)=0
	Adds a new render target texture with 6 sides for a cubemap map to the texture cache. More...

virtual void	removeTexture (ITexture *texture)=0
	Removes a texture from the texture cache and deletes it. More...

virtual void	removeAllTextures ()=0
	Removes all textures from the texture cache and deletes them. More...

virtual void	removeHardwareBuffer (const scene::IMeshBuffer *mb)=0
	Remove hardware buffer. More...

virtual void	removeAllHardwareBuffers ()=0
	Remove all hardware buffers. More...

virtual void	addOcclusionQuery (scene::ISceneNode node, const scene::IMesh mesh=0)=0
	Create occlusion query. More...

virtual void	removeOcclusionQuery (scene::ISceneNode *node)=0
	Remove occlusion query. More...

virtual void	removeAllOcclusionQueries ()=0
	Remove all occlusion queries. More...

virtual void	runOcclusionQuery (scene::ISceneNode *node, bool visible=false)=0
	Run occlusion query. Draws mesh stored in query. More...

virtual void	runAllOcclusionQueries (bool visible=false)=0
	Run all occlusion queries. Draws all meshes stored in queries. More...

virtual void	updateOcclusionQuery (scene::ISceneNode *node, bool block=true)=0
	Update occlusion query. Retrieves results from GPU. More...

virtual void	updateAllOcclusionQueries (bool block=true)=0
	Update all occlusion queries. Retrieves results from GPU. More...

virtual u32	getOcclusionQueryResult (scene::ISceneNode *node) const =0
	Return query result. More...

virtual IRenderTarget *	addRenderTarget ()=0
	Create render target. More...

virtual void	removeRenderTarget (IRenderTarget *renderTarget)=0
	Remove render target. More...

virtual void	removeAllRenderTargets ()=0
	Remove all render targets. More...

virtual void	makeColorKeyTexture (video::ITexture *texture, video::SColor color, bool zeroTexels=false) const =0
	Sets a boolean alpha channel on the texture based on a color key. More...

virtual void	makeColorKeyTexture (video::ITexture *texture, core::position2d< s32 > colorKeyPixelPos, bool zeroTexels=false) const =0
	Sets a boolean alpha channel on the texture based on the color at a position. More...

virtual void	makeNormalMapTexture (video::ITexture *texture, f32 amplitude=1.0f) const =0
	Creates a normal map from a height map texture. More...

virtual bool	setRenderTargetEx (IRenderTarget *target, u16 clearFlag, SColor clearColor=SColor(255, 0, 0, 0), f32 clearDepth=1.f, u8 clearStencil=0)=0
	Set a render target. More...

virtual bool	setRenderTarget (ITexture *texture, u16 clearFlag=ECBF_COLOR\|ECBF_DEPTH, SColor clearColor=SColor(255, 0, 0, 0), f32 clearDepth=1.f, u8 clearStencil=0)=0
	Sets a new render target. More...

bool	setRenderTarget (ITexture *texture, bool clearBackBuffer, bool clearZBuffer, SColor color=SColor(255, 0, 0, 0))

virtual void	setViewPort (const core::rect< s32 > &area)=0
	Sets a new viewport. More...

virtual const core::rect< s32 > &	getViewPort () const =0
	Gets the area of the current viewport. More...

virtual void	drawVertexPrimitiveList (const void vertices, u32 vertexCount, const void indexList, u32 primCount, E_VERTEX_TYPE vType=EVT_STANDARD, scene::E_PRIMITIVE_TYPE pType=scene::EPT_TRIANGLES, E_INDEX_TYPE iType=EIT_16BIT)=0
	Draws a vertex primitive list. More...

virtual void	draw2DVertexPrimitiveList (const void vertices, u32 vertexCount, const void indexList, u32 primCount, E_VERTEX_TYPE vType=EVT_STANDARD, scene::E_PRIMITIVE_TYPE pType=scene::EPT_TRIANGLES, E_INDEX_TYPE iType=EIT_16BIT)=0
	Draws a vertex primitive list in 2d. More...

void	drawIndexedTriangleList (const S3DVertex vertices, u32 vertexCount, const u16 indexList, u32 triangleCount)
	Draws an indexed triangle list. More...

void	drawIndexedTriangleList (const S3DVertex2TCoords vertices, u32 vertexCount, const u16 indexList, u32 triangleCount)
	Draws an indexed triangle list. More...

void	drawIndexedTriangleList (const S3DVertexTangents vertices, u32 vertexCount, const u16 indexList, u32 triangleCount)
	Draws an indexed triangle list. More...

void	drawIndexedTriangleFan (const S3DVertex vertices, u32 vertexCount, const u16 indexList, u32 triangleCount)
	Draws an indexed triangle fan. More...

void	drawIndexedTriangleFan (const S3DVertex2TCoords vertices, u32 vertexCount, const u16 indexList, u32 triangleCount)
	Draws an indexed triangle fan. More...

void	drawIndexedTriangleFan (const S3DVertexTangents vertices, u32 vertexCount, const u16 indexList, u32 triangleCount)
	Draws an indexed triangle fan. More...

virtual void	draw3DLine (const core::vector3df &start, const core::vector3df &end, SColor color=SColor(255, 255, 255, 255))=0
	Draws a 3d line. More...

virtual void	draw3DTriangle (const core::triangle3df &triangle, SColor color=SColor(255, 255, 255, 255))=0
	Draws a 3d triangle. More...

virtual void	draw3DBox (const core::aabbox3d< f32 > &box, SColor color=SColor(255, 255, 255, 255))=0
	Draws a 3d axis aligned box. More...

virtual void	draw2DImage (const video::ITexture *texture, const core::position2d< s32 > &destPos, bool useAlphaChannelOfTexture=false)=0
	Draws a 2d image without any special effects. More...

virtual void	draw2DImage (const video::ITexture texture, const core::position2d< s32 > &destPos, const core::rect< s32 > &sourceRect, const core::rect< s32 > clipRect=0, SColor color=SColor(255, 255, 255, 255), bool useAlphaChannelOfTexture=false)=0
	Draws a 2d image using a color. More...

virtual void	draw2DImageBatch (const video::ITexture texture, const core::position2d< s32 > &pos, const core::array< core::rect< s32 > > &sourceRects, const core::array< s32 > &indices, s32 kerningWidth=0, const core::rect< s32 > clipRect=0, SColor color=SColor(255, 255, 255, 255), bool useAlphaChannelOfTexture=false)=0
	Draws a set of 2d images, using a color and the alpha channel of the texture. More...

virtual void	draw2DImageBatch (const video::ITexture texture, const core::array< core::position2d< s32 > > &positions, const core::array< core::rect< s32 > > &sourceRects, const core::rect< s32 > clipRect=0, SColor color=SColor(255, 255, 255, 255), bool useAlphaChannelOfTexture=false)=0
	Draws a set of 2d images, using a color and the alpha channel of the texture. More...

virtual void	draw2DImage (const video::ITexture texture, const core::rect< s32 > &destRect, const core::rect< s32 > &sourceRect, const core::rect< s32 > clipRect=0, const video::SColor *const colors=0, bool useAlphaChannelOfTexture=false)=0
	Draws a part of the texture into the rectangle. Note that colors must be an array of 4 colors if used. More...

virtual void	draw2DRectangle (SColor color, const core::rect< s32 > &pos, const core::rect< s32 > *clip=0)=0
	Draws a 2d rectangle. More...

virtual void	draw2DRectangle (const core::rect< s32 > &pos, SColor colorLeftUp, SColor colorRightUp, SColor colorLeftDown, SColor colorRightDown, const core::rect< s32 > *clip=0)=0
	Draws a 2d rectangle with a gradient. More...

virtual void	draw2DRectangleOutline (const core::recti &pos, SColor color=SColor(255, 255, 255, 255))=0
	Draws the outline of a 2D rectangle. More...

virtual void	draw2DLine (const core::position2d< s32 > &start, const core::position2d< s32 > &end, SColor color=SColor(255, 255, 255, 255))=0
	Draws a 2d line. More...

virtual void	drawPixel (u32 x, u32 y, const SColor &color)=0
	Draws a pixel. More...

virtual void	draw2DPolygon (core::position2d< s32 > center, f32 radius, video::SColor color=SColor(100, 255, 255, 255), s32 vertexCount=10)=0
	Draws a non filled concyclic regular 2d polygon. More...

virtual void	drawStencilShadowVolume (const core::array< core::vector3df > &triangles, bool zfail=true, u32 debugDataVisible=0)=0
	Draws a shadow volume into the stencil buffer. More...

virtual void	drawStencilShadow (bool clearStencilBuffer=false, video::SColor leftUpEdge=video::SColor(255, 0, 0, 0), video::SColor rightUpEdge=video::SColor(255, 0, 0, 0), video::SColor leftDownEdge=video::SColor(255, 0, 0, 0), video::SColor rightDownEdge=video::SColor(255, 0, 0, 0))=0
	Fills the stencil shadow with color. More...

virtual void	drawMeshBuffer (const scene::IMeshBuffer *mb)=0
	Draws a mesh buffer. More...

virtual void	drawMeshBufferNormals (const scene::IMeshBuffer *mb, f32 length=10.f, SColor color=0xffffffff)=0
	Draws normals of a mesh buffer. More...

virtual void	setFog (SColor color=SColor(0, 255, 255, 255), E_FOG_TYPE fogType=EFT_FOG_LINEAR, f32 start=50.0f, f32 end=100.0f, f32 density=0.01f, bool pixelFog=false, bool rangeFog=false)=0
	Sets the fog mode. More...

virtual void	getFog (SColor &color, E_FOG_TYPE &fogType, f32 &start, f32 &end, f32 &density, bool &pixelFog, bool &rangeFog)=0
	Gets the fog mode. More...

virtual ECOLOR_FORMAT	getColorFormat () const =0
	Get the current color format of the color buffer. More...

virtual const core::dimension2d< u32 > &	getScreenSize () const =0
	Get the size of the screen or render window. More...

virtual const core::dimension2d< u32 > &	getCurrentRenderTargetSize () const =0
	Get the size of the current render target. More...

virtual s32	getFPS () const =0
	Returns current frames per second value. More...

virtual u32	getPrimitiveCountDrawn (u32 mode=0) const =0
	Returns amount of primitives (mostly triangles) which were drawn in the last frame. More...

virtual void	deleteAllDynamicLights ()=0
	Deletes all dynamic lights which were previously added with addDynamicLight(). More...

virtual s32	addDynamicLight (const SLight &light)=0

virtual u32	getMaximalDynamicLightAmount () const =0
	Returns the maximal amount of dynamic lights the device can handle. More...

virtual u32	getDynamicLightCount () const =0
	Returns amount of dynamic lights currently set. More...

virtual const SLight &	getDynamicLight (u32 idx) const =0
	Returns light data which was previously set by IVideoDriver::addDynamicLight(). More...

virtual void	turnLightOn (s32 lightIndex, bool turnOn)=0

virtual const wchar_t *	getName () const =0
	Gets name of this video driver. More...

virtual void	addExternalImageLoader (IImageLoader *loader)=0
	Adds an external image loader to the engine. More...

virtual void	addExternalImageWriter (IImageWriter *writer)=0
	Adds an external image writer to the engine. More...

virtual u32	getMaximalPrimitiveCount () const =0
	Returns the maximum amount of primitives. More...

virtual void	setTextureCreationFlag (E_TEXTURE_CREATION_FLAG flag, bool enabled=true)=0
	Enables or disables a texture creation flag. More...

virtual bool	getTextureCreationFlag (E_TEXTURE_CREATION_FLAG flag) const =0
	Returns if a texture creation flag is enabled or disabled. More...

virtual core::array< IImage * >	createImagesFromFile (const io::path &filename, E_TEXTURE_TYPE *type=0)=0
	Creates a software images from a file. More...

virtual core::array< IImage * >	createImagesFromFile (io::IReadFile file, E_TEXTURE_TYPE type=0)=0
	Creates a software images from a file. More...

IImage *	createImageFromFile (const io::path &filename)
	Creates a software image from a file. More...

IImage *	createImageFromFile (io::IReadFile *file)
	Creates a software image from a file. More...

virtual bool	writeImageToFile (IImage *image, const io::path &filename, u32 param=0)=0
	Writes the provided image to a file. More...

virtual bool	writeImageToFile (IImage image, io::IWriteFile file, u32 param=0)=0
	Writes the provided image to a file. More...

virtual IImage *	createImageFromData (ECOLOR_FORMAT format, const core::dimension2d< u32 > &size, void *data, bool ownForeignMemory=false, bool deleteMemory=true)=0
	Creates a software image from a byte array. More...

virtual IImage *	createImage (ECOLOR_FORMAT format, const core::dimension2d< u32 > &size)=0
	Creates an empty software image. More...

virtual _IRR_DEPRECATED_ IImage *	createImage (ECOLOR_FORMAT format, IImage *imageToCopy)=0
	Creates a software image by converting it to given format from another image. More...

virtual _IRR_DEPRECATED_ IImage *	createImage (IImage *imageToCopy, const core::position2d< s32 > &pos, const core::dimension2d< u32 > &size)=0
	Creates a software image from a part of another image. More...

virtual IImage *	createImage (ITexture *texture, const core::position2d< s32 > &pos, const core::dimension2d< u32 > &size)=0
	Creates a software image from a part of a texture. More...

virtual void	OnResize (const core::dimension2d< u32 > &size)=0
	Event handler for resize events. Only used by the engine internally. More...

virtual s32	addMaterialRenderer (IMaterialRenderer renderer, const c8 name=0)=0
	Adds a new material renderer to the video device. More...

virtual IMaterialRenderer *	getMaterialRenderer (u32 idx) const =0
	Get access to a material renderer by index. More...

virtual u32	getMaterialRendererCount () const =0
	Get amount of currently available material renderers. More...

virtual const c8 *	getMaterialRendererName (u32 idx) const =0
	Get name of a material renderer. More...

virtual void	setMaterialRendererName (s32 idx, const c8 *name)=0
	Sets the name of a material renderer. More...

virtual void	swapMaterialRenderers (u32 idx1, u32 idx2, bool swapNames=true)=0
	Swap the material renderers used for certain id's. More...

virtual io::IAttributes *	createAttributesFromMaterial (const video::SMaterial &material, io::SAttributeReadWriteOptions *options=0)=0
	Creates material attributes list from a material. More...

virtual void	fillMaterialStructureFromAttributes (video::SMaterial &outMaterial, io::IAttributes *attributes)=0
	Fills an SMaterial structure from attributes. More...

virtual const SExposedVideoData &	getExposedVideoData ()=0
	Returns driver and operating system specific data about the IVideoDriver. More...

virtual E_DRIVER_TYPE	getDriverType () const =0
	Get type of video driver. More...

virtual IGPUProgrammingServices *	getGPUProgrammingServices ()=0
	Gets the IGPUProgrammingServices interface. More...

virtual scene::IMeshManipulator *	getMeshManipulator ()=0
	Returns a pointer to the mesh manipulator. More...

virtual void	clearBuffers (u16 flag, SColor color=SColor(255, 0, 0, 0), f32 depth=1.f, u8 stencil=0)=0
	Clear the color, depth and/or stencil buffers. More...

_IRR_DEPRECATED_ void	clearBuffers (bool backBuffer, bool depthBuffer, bool stencilBuffer, SColor color)
	Clear the color, depth and/or stencil buffers. More...

_IRR_DEPRECATED_ void	clearZBuffer ()
	Clears the ZBuffer. More...

virtual IImage *	createScreenShot (video::ECOLOR_FORMAT format=video::ECF_UNKNOWN, video::E_RENDER_TARGET target=video::ERT_FRAME_BUFFER)=0
	Make a screenshot of the last rendered frame. More...

virtual video::ITexture *	findTexture (const io::path &filename)=0
	Check if the image is already loaded. More...

virtual bool	setClipPlane (u32 index, const core::plane3df &plane, bool enable=false)=0
	Set or unset a clipping plane. More...

virtual void	enableClipPlane (u32 index, bool enable)=0
	Enable or disable a clipping plane. More...

virtual void	setMinHardwareBufferVertexCount (u32 count)=0
	Set the minimum number of vertices for which a hw buffer will be created. More...

virtual SOverrideMaterial &	getOverrideMaterial ()=0
	Get the global Material, which might override local materials. More...

virtual SMaterial &	getMaterial2D ()=0
	Get the 2d override material for altering its values. More...

virtual void	enableMaterial2D (bool enable=true)=0
	Enable the 2d override material. More...

virtual core::stringc	getVendorInfo ()=0
	Get the graphics card vendor name. More...

virtual void	setAmbientLight (const SColorf &color)=0
	Only used by the engine internally. More...

virtual const SColorf &	getAmbientLight () const =0
	Get the global ambient light currently used by the driver. More...

virtual void	setAllowZWriteOnTransparent (bool flag)=0
	Only used by the engine internally. More...

virtual core::dimension2du	getMaxTextureSize () const =0
	Get the maximum texture size supported. More...

virtual void	convertColor (const void sP, ECOLOR_FORMAT sF, s32 sN, void dP, ECOLOR_FORMAT dF) const =0
	Color conversion convenience function. More...

virtual bool	queryTextureFormat (ECOLOR_FORMAT format) const =0
	Check if the driver supports creating textures with the given color format. More...

virtual bool	needsTransparentRenderPass (const irr::video::SMaterial &material) const =0
	Used by some SceneNodes to check if a material should be rendered in the transparent render pass. More...

virtual bool	removeMaterialRenderer (u32 idx)

virtual void	addShaderConstant (const SShaderConstant &value)

virtual SShaderConstant *	getShaderConstant (irr::u32 num)

virtual void	clearShaderConstant ()

virtual irr::u32	getShaderConstantSize () const

virtual void	setVirtualScreenSize (const core::dimension2du &size)

virtual core::dimension2du	getVirtualScreenSize () const

Public Member Functions inherited from irr::IReferenceCounted
	IReferenceCounted ()
	Constructor. More...

virtual	~IReferenceCounted ()
	Destructor. More...

void	grab () const
	Grabs the object. Increments the reference counter by one. More...

bool	drop () const
	Drops the object. Decrements the reference counter by one. More...

s32	getReferenceCount () const
	Get the reference count. More...

const c8 *	getDebugName () const
	Returns the debug name of the object. More...

Additional Inherited Members
Protected Member Functions inherited from irr::IReferenceCounted
void	setDebugName (const c8 *newName)
	Sets the debug name of the object. More...

Detailed Description

Interface to driver which is able to perform 2d and 3d graphics functions.

This interface is one of the most important interfaces of the Irrlicht Engine: All rendering and texture manipulation is done with this interface. You are able to use the Irrlicht Engine by only invoking methods of this interface if you like to, although the irr::scene::ISceneManager interface provides a lot of powerful classes and methods to make the programmer's life easier.

Definition at line 151 of file IVideoDriver.h.

Member Enumeration Documentation

◆ E_SHADER_VAR_TYPE

enum irr::video::IVideoDriver::E_SHADER_VAR_TYPE

Enumerator
ESVT_INT32
ESVT_FLOAT32
ESVT_VEC2
ESVT_VEC3
ESVT_VEC4
ESVT_MAT4
ESVT_COUNT

Definition at line 1536 of file IVideoDriver.h.

                 {
                         ESVT_INT32 = 0,
                         ESVT_FLOAT32,
                         ESVT_VEC2,
                         ESVT_VEC3,
                         ESVT_VEC4,
                         ESVT_MAT4,
                         ESVT_COUNT
                 };

Member Function Documentation

◆ addDynamicLight()

virtual s32 irr::video::IVideoDriver::addDynamicLight ( const SLight & light )

pure virtual

adds a dynamic light, returning an index to the light

Parameters

light the light data to use to create the light

Returns: An index to the light, or -1 if an error occurs

◆ addExternalImageLoader()

virtual void irr::video::IVideoDriver::addExternalImageLoader ( IImageLoader * loader )

pure virtual

Adds an external image loader to the engine.

This is useful if the Irrlicht Engine should be able to load textures of currently unsupported file formats (e.g. gif). The IImageLoader only needs to be implemented for loading this file format. A pointer to the implementation can be passed to the engine using this method.

Parameters

loader Pointer to the external loader created.

◆ addExternalImageWriter()

virtual void irr::video::IVideoDriver::addExternalImageWriter ( IImageWriter * writer )

pure virtual

Adds an external image writer to the engine.

This is useful if the Irrlicht Engine should be able to write textures of currently unsupported file formats (e.g .gif). The IImageWriter only needs to be implemented for writing this file format. A pointer to the implementation can be passed to the engine using this method.

Parameters

writer Pointer to the external writer created.

◆ addMaterialRenderer()

virtual s32 irr::video::IVideoDriver::addMaterialRenderer	(	IMaterialRenderer *	renderer,
		const c8 *	name = `0`
	)

pure virtual

Adds a new material renderer to the video device.

Use this method to extend the VideoDriver with new material types. To extend the engine using this method do the following: Derive a class from IMaterialRenderer and override the methods you need. For setting the right renderstates, you can try to get a pointer to the real rendering device using IVideoDriver::getExposedVideoData(). Add your class with IVideoDriver::addMaterialRenderer(). To use an object being displayed with your new material, set the MaterialType member of the SMaterial struct to the value returned by this method. If you simply want to create a new material using vertex and/or pixel shaders it would be easier to use the video::IGPUProgrammingServices interface which you can get using the getGPUProgrammingServices() method.

Parameters

renderer	A pointer to the new renderer.
name	Optional name for the material renderer entry.

Returns: The number of the material type which can be set in SMaterial::MaterialType to use the renderer. -1 is returned if an error occurred. For example if you tried to add an material renderer to the software renderer or the null device, which do not accept material renderers.

◆ addOcclusionQuery()

virtual void irr::video::IVideoDriver::addOcclusionQuery	(	scene::ISceneNode *	node,
		const scene::IMesh *	mesh = `0`
	)

pure virtual

Create occlusion query.

Use node for identification and mesh for occlusion test.

◆ addRenderTarget()

virtual IRenderTarget* irr::video::IVideoDriver::addRenderTarget ( )

pure virtual

Create render target.

◆ addRenderTargetTexture()

virtual ITexture* irr::video::IVideoDriver::addRenderTargetTexture	(	const core::dimension2d< u32 > &	size,
		const io::path &	name = `"rt"`,
		const ECOLOR_FORMAT	format = `ECF_UNKNOWN`
	)

pure virtual

Adds a new render target texture to the texture cache.

Parameters

size	Size of the texture, in pixels. Width and height should be a power of two (e.g. 64, 128, 256, 512, ...) and it should not be bigger than the backbuffer, because it shares the zbuffer with the screen buffer.
name	A name for the texture. Later calls of getTexture() with this name will return this texture. The name can not be empty.
format	The color format of the render target. Floating point formats are supported.

Returns: Pointer to the created texture or 0 if the texture could not be created. This pointer should not be dropped. See IReferenceCounted::drop() for more information.

◆ addRenderTargetTextureCubemap()

virtual ITexture* irr::video::IVideoDriver::addRenderTargetTextureCubemap	(	const irr::u32	sideLen,
		const io::path &	name = `"rt"`,
		const ECOLOR_FORMAT	format = `ECF_UNKNOWN`
	)

pure virtual

Adds a new render target texture with 6 sides for a cubemap map to the texture cache.

NOTE: Only supported on D3D9 so far.

Parameters

sideLen	Length of one cubemap side.
name	A name for the texture. Later calls of getTexture() with this name will return this texture. The name can not be empty.
format	The color format of the render target. Floating point formats are supported.

Returns: Pointer to the created texture or 0 if the texture could not be created. This pointer should not be dropped. See IReferenceCounted::drop() for more information.

◆ addShaderConstant()

virtual void irr::video::IVideoDriver::addShaderConstant ( const SShaderConstant & value )

inlinevirtual

Definition at line 1572 of file IVideoDriver.h.

1572 { }

◆ addTexture() [1/3]

virtual ITexture* irr::video::IVideoDriver::addTexture	(	const core::dimension2d< u32 > &	size,
		const io::path &	name,
		ECOLOR_FORMAT	format = `ECF_A8R8G8B8`
	)

pure virtual

Creates an empty texture of specified size.

Parameters

size	Size of the texture.
name	A name for the texture. Later calls to getTexture() with this name will return this texture. The name can not be empty.
format	Desired color format of the texture. Please note that the driver may choose to create the texture in another color format.

Returns: Pointer to the newly created texture. This pointer should not be dropped. See IReferenceCounted::drop() for more information.

◆ addTexture() [2/3]

_IRR_DEPRECATED_ ITexture* irr::video::IVideoDriver::addTexture	(	const io::path &	name,
		IImage *	image,
		void *	mipmapData
	)

inline

Creates a texture from an IImage.

Parameters

name	A name for the texture. Later calls of getTexture() with this name will return this texture. The name can not be empty.
image	Image the texture is created from.
mipmapData	Optional pointer to a mipmaps data. If this parameter is not given, the mipmaps are derived from image.

Returns: Pointer to the newly created texture. This pointer should not be dropped. See IReferenceCounted::drop() for more information.

Definition at line 333 of file IVideoDriver.h.

                 {
                         if (image)
                                 image->setMipMapsData(mipmapData, false, true);
 
                         return addTexture(name, image);
                 }

◆ addTexture() [3/3]

virtual ITexture* irr::video::IVideoDriver::addTexture	(	const io::path &	name,
		IImage *	image
	)

pure virtual

Creates a texture from an IImage.

Parameters

name	A name for the texture. Later calls of getTexture() with this name will return this texture. The name can not be empty.
image	Image the texture is created from.

Returns: Pointer to the newly created texture. This pointer should not be dropped. See IReferenceCounted::drop() for more information.

◆ addTextureCubemap() [1/2]

virtual ITexture* irr::video::IVideoDriver::addTextureCubemap	(	const io::path &	name,
		IImage *	imagePosX,
		IImage *	imageNegX,
		IImage *	imagePosY,
		IImage *	imageNegY,
		IImage *	imagePosZ,
		IImage *	imageNegZ
	)

pure virtual

Creates a cubemap texture from loaded IImages.

Parameters

name	A name for the texture. Later calls of getTexture() with this name will return this texture. The name can not be empty.
imagePosX	Image (positive X) the texture is created from.
imageNegX	Image (negative X) the texture is created from.
imagePosY	Image (positive Y) the texture is created from.
imageNegY	Image (negative Y) the texture is created from.
imagePosZ	Image (positive Z) the texture is created from.
imageNegZ	Image (negative Z) the texture is created from.

Returns: Pointer to the newly created texture. This pointer should not be dropped. See IReferenceCounted::drop() for more information.

◆ addTextureCubemap() [2/2]

virtual ITexture* irr::video::IVideoDriver::addTextureCubemap	(	const irr::u32	sideLen,
		const io::path &	name,
		ECOLOR_FORMAT	format = `ECF_A8R8G8B8`
	)

pure virtual

Creates an empty cubemap texture of specified size.

Parameters

sideLen	diameter of one side of the cube
name	A name for the texture. Later calls of getTexture() with this name will return this texture. The name can not be empty.
format	Desired color format of the texture. Please note that the driver may choose to create the texture in another color format.

Returns: Pointer to the newly created texture.

◆ beginScene() [1/2]

virtual bool irr::video::IVideoDriver::beginScene	(	u16	clearFlag = `(u16)(ECBF_COLOR\|ECBF_DEPTH)`,
		SColor	clearColor = `SColor(255, 0, 0, 0)`,
		f32	clearDepth = `1.f`,
		u8	clearStencil = `0`,
		const SExposedVideoData &	videoData = `SExposedVideoData()`,
		core::rect< s32 > *	sourceRect = `0`
	)

pure virtual

Applications must call this method before performing any rendering.

This method can clear the back- and the z-buffer.

Parameters

clearFlag	A combination of the E_CLEAR_BUFFER_FLAG bit-flags.
clearColor	The clear color for the color buffer.
clearDepth	The clear value for the depth buffer.
clearStencil	The clear value for the stencil buffer.
videoData	Handle of another window, if you want the bitmap to be displayed on another window. If this is an empty element, everything will be displayed in the default window. Note: This feature is not fully implemented for all devices.
sourceRect	Pointer to a rectangle defining the source rectangle of the area to be presented. Set to null to present everything. Note: not implemented in all devices.

Returns: False if failed.

◆ beginScene() [2/2]

bool irr::video::IVideoDriver::beginScene	(	bool	backBuffer,
		bool	zBuffer,
		SColor	color = `SColor(255,0,0,0)`,
		const SExposedVideoData &	videoData = `SExposedVideoData()`,
		core::rect< s32 > *	sourceRect = `0`
	)

inline

Alternative beginScene implementation. Can't clear stencil buffer, but otherwise identical to other beginScene.

Definition at line 173 of file IVideoDriver.h.

                 {
                         u16 flag = 0;
 
                         if (backBuffer)
                                 flag |= ECBF_COLOR;
 
                         if (zBuffer)
                                 flag |= ECBF_DEPTH;
 
                         return beginScene(flag, color, 1.f, 0, videoData, sourceRect);
                 }

◆ checkDriverReset()

virtual bool irr::video::IVideoDriver::checkDriverReset ( )

pure virtual

Check if the driver was recently reset.

For d3d devices you will need to recreate the RTTs if the driver was reset. Should be queried right after beginScene().

◆ clearBuffers() [1/2]

virtual void irr::video::IVideoDriver::clearBuffers	(	u16	flag,
		SColor	color = `SColor(255, 0, 0, 0)`,
		f32	depth = `1.f`,
		u8	stencil = `0`
	)

pure virtual

Clear the color, depth and/or stencil buffers.

◆ clearBuffers() [2/2]

_IRR_DEPRECATED_ void irr::video::IVideoDriver::clearBuffers	(	bool	backBuffer,
		bool	depthBuffer,
		bool	stencilBuffer,
		SColor	color
	)

inline

Clear the color, depth and/or stencil buffers.

Definition at line 1401 of file IVideoDriver.h.

                 {
                         u16 flag = 0;
 
                         if (backBuffer)
                                 flag |= ECBF_COLOR;
 
                         if (depthBuffer)
                                 flag |= ECBF_DEPTH;
 
                         if (stencilBuffer)
                                 flag |= ECBF_STENCIL;
 
                         clearBuffers(flag, color);
                 }

◆ clearShaderConstant()

virtual void irr::video::IVideoDriver::clearShaderConstant ( )

inlinevirtual

Definition at line 1574 of file IVideoDriver.h.

1574 { }

◆ clearZBuffer()

_IRR_DEPRECATED_ void irr::video::IVideoDriver::clearZBuffer ( )

inline

Clears the ZBuffer.

Note that you usually need not to call this method, as it is automatically done in IVideoDriver::beginScene() or IVideoDriver::setRenderTarget() if you enable zBuffer. But if you have to render some special things, you can clear the zbuffer during the rendering process with this method any time.

Definition at line 1424 of file IVideoDriver.h.

                 {
                         clearBuffers(ECBF_DEPTH, SColor(255,0,0,0), 1.f, 0);
                 }

◆ convertColor()

virtual void irr::video::IVideoDriver::convertColor	(	const void *	sP,
		ECOLOR_FORMAT	sF,
		s32	sN,
		void *	dP,
		ECOLOR_FORMAT	dF
	)		const

pure virtual

Color conversion convenience function.

Convert an image (as array of pixels) from source to destination array, thereby converting the color format. The pixel size is determined by the color formats.

Parameters

sP	Pointer to source
sF	Color format of source
sN	Number of pixels to convert, both array must be large enough
dP	Pointer to destination
dF	Color format of destination

◆ createAttributesFromMaterial()

virtual io::IAttributes* irr::video::IVideoDriver::createAttributesFromMaterial	(	const video::SMaterial &	material,
		io::SAttributeReadWriteOptions *	options = `0`
	)

pure virtual

Creates material attributes list from a material.

This method is useful for serialization and more. Please note that the video driver will use the material renderer names from getMaterialRendererName() to write out the material type name, so they should be set before.

Parameters

material	The material to serialize.
options	Additional options which might influence the serialization.

Returns: The io::IAttributes container holding the material properties.

◆ createImage() [1/4]

virtual IImage* irr::video::IVideoDriver::createImage	(	ECOLOR_FORMAT	format,
		const core::dimension2d< u32 > &	size
	)

pure virtual

Creates an empty software image.

Parameters

format	Desired color format of the image.
size	Size of the image to create.

Returns: The created image. If you no longer need the image, you should call IImage::drop(). See IReferenceCounted::drop() for more information.

◆ createImage() [2/4]

virtual _IRR_DEPRECATED_ IImage* irr::video::IVideoDriver::createImage	(	ECOLOR_FORMAT	format,
		IImage *	imageToCopy
	)

pure virtual

Creates a software image by converting it to given format from another image.

Deprecated:: Create an empty image and use copyTo(). This method may be removed by Irrlicht 1.9.

Parameters

format	Desired color format of the image.
imageToCopy	Image to copy to the new image.

Returns: The created image. If you no longer need the image, you should call IImage::drop(). See IReferenceCounted::drop() for more information.

◆ createImage() [3/4]

virtual _IRR_DEPRECATED_ IImage* irr::video::IVideoDriver::createImage	(	IImage *	imageToCopy,
		const core::position2d< s32 > &	pos,
		const core::dimension2d< u32 > &	size
	)

pure virtual

Creates a software image from a part of another image.

Deprecated:: Create an empty image and use copyTo(). This method may be removed by Irrlicht 1.9.

Parameters

imageToCopy	Image to copy to the new image in part.
pos	Position of rectangle to copy.
size	Extents of rectangle to copy.

Returns: The created image. If you no longer need the image, you should call IImage::drop(). See IReferenceCounted::drop() for more information.

◆ createImage() [4/4]

virtual IImage* irr::video::IVideoDriver::createImage	(	ITexture *	texture,
		const core::position2d< s32 > &	pos,
		const core::dimension2d< u32 > &	size
	)

pure virtual

Creates a software image from a part of a texture.

Parameters

texture	Texture to copy to the new image in part.
pos	Position of rectangle to copy.
size	Extents of rectangle to copy.

Returns: The created image. If you no longer need the image, you should call IImage::drop(). See IReferenceCounted::drop() for more information.

◆ createImageFromData()

virtual IImage* irr::video::IVideoDriver::createImageFromData	(	ECOLOR_FORMAT	format,
		const core::dimension2d< u32 > &	size,
		void *	data,
		bool	ownForeignMemory = `false`,
		bool	deleteMemory = `true`
	)

pure virtual

Creates a software image from a byte array.

No hardware texture will be created for this image. This method is useful for example if you want to read a heightmap for a terrain renderer.

Parameters

format	Desired color format of the texture
size	Desired size of the image
data	A byte array with pixel color information
ownForeignMemory	If true, the image will use the data pointer directly and own it afterward. If false, the memory will by copied internally. WARNING: Setting this to 'true' will not work across dll boundaries. So unless you link Irrlicht statically you should keep this to 'false'. The parameter is mainly for internal usage.
deleteMemory	Whether the memory is deallocated upon destruction.

Returns: The created image. If you no longer need the image, you should call IImage::drop(). See IReferenceCounted::drop() for more information.

◆ createImageFromFile() [1/2]

IImage* irr::video::IVideoDriver::createImageFromFile ( const io::path & filename )

inline

Creates a software image from a file.

No hardware texture will be created for this image. This method is useful for example if you want to read a heightmap for a terrain renderer.

Parameters

filename Name of the file from which the image is created.

Returns: The created image. If you no longer need the image, you should call IImage::drop(). See IReferenceCounted::drop() for more information.

Definition at line 1174 of file IVideoDriver.h.

                 {
                         core::array<IImage*> imageArray = createImagesFromFile(filename);
 
                         for (u32 i = 1; i < imageArray.size(); ++i)
                                 imageArray[i]->drop();
 
                         return (imageArray.size() > 0) ? imageArray[0] : 0;
                 }

◆ createImageFromFile() [2/2]

IImage* irr::video::IVideoDriver::createImageFromFile ( io::IReadFile * file )

inline

Creates a software image from a file.

No hardware texture will be created for this image. This method is useful for example if you want to read a heightmap for a terrain renderer.

Parameters

file	File from which the image is created.

Returns: The created image. If you no longer need the image, you should call IImage::drop(). See IReferenceCounted::drop() for more information.

Definition at line 1192 of file IVideoDriver.h.

                 {
                         core::array<IImage*> imageArray = createImagesFromFile(file);
 
                         for (u32 i = 1; i < imageArray.size(); ++i)
                                 imageArray[i]->drop();
 
                         return (imageArray.size() > 0) ? imageArray[0] : 0;
                 }

◆ createImagesFromFile() [1/2]

virtual core::array<IImage*> irr::video::IVideoDriver::createImagesFromFile	(	const io::path &	filename,
		E_TEXTURE_TYPE *	type = `0`
	)

pure virtual

Creates a software images from a file.

No hardware texture will be created for those images. This method is useful for example if you want to read a heightmap for a terrain renderer.

Parameters

filename	Name of the file from which the images are created.
type	Pointer to E_TEXTURE_TYPE where a recommended type of the texture will be stored.

Returns: The array of created images. If you no longer need those images, you should call IImage::drop() on each of them. See IReferenceCounted::drop() for more information.

◆ createImagesFromFile() [2/2]

virtual core::array<IImage*> irr::video::IVideoDriver::createImagesFromFile	(	io::IReadFile *	file,
		E_TEXTURE_TYPE *	type = `0`
	)

pure virtual

Creates a software images from a file.

No hardware texture will be created for those images. This method is useful for example if you want to read a heightmap for a terrain renderer.

Parameters

file	File from which the image is created.
type	Pointer to E_TEXTURE_TYPE where a recommended type of the texture will be stored.

Returns: The array of created images. If you no longer need those images, you should call IImage::drop() on each of them. See IReferenceCounted::drop() for more information.

◆ createScreenShot()

virtual IImage* irr::video::IVideoDriver::createScreenShot	(	video::ECOLOR_FORMAT	format = `video::ECF_UNKNOWN`,
		video::E_RENDER_TARGET	target = `video::ERT_FRAME_BUFFER`
	)

pure virtual

Make a screenshot of the last rendered frame.

Returns: An image created from the last rendered frame.

◆ deleteAllDynamicLights()

virtual void irr::video::IVideoDriver::deleteAllDynamicLights ( )

pure virtual

Deletes all dynamic lights which were previously added with addDynamicLight().

◆ disableFeature()

virtual void irr::video::IVideoDriver::disableFeature	(	E_VIDEO_DRIVER_FEATURE	feature,
		bool	flag = `true`
	)

pure virtual

Disable a feature of the driver.

Can also be used to enable the features again. It is not possible to enable unsupported features this way, though.

Parameters

feature	Feature to disable.
flag	When true the feature is disabled, otherwise it is enabled.

◆ draw2DImage() [1/3]

virtual void irr::video::IVideoDriver::draw2DImage	(	const video::ITexture *	texture,
		const core::position2d< s32 > &	destPos,
		bool	useAlphaChannelOfTexture = `false`
	)

pure virtual

Draws a 2d image without any special effects.

Parameters

texture	Pointer to texture to use.
destPos	Upper left 2d destination position where the image will be drawn.
useAlphaChannelOfTexture	If true, the alpha channel of the texture is used to draw the image.

◆ draw2DImage() [2/3]

virtual void irr::video::IVideoDriver::draw2DImage	(	const video::ITexture *	texture,
		const core::position2d< s32 > &	destPos,
		const core::rect< s32 > &	sourceRect,
		const core::rect< s32 > *	clipRect = `0`,
		SColor	color = `SColor(255, 255, 255, 255)`,
		bool	useAlphaChannelOfTexture = `false`
	)

pure virtual

Draws a 2d image using a color.

(if color is other than Color(255,255,255,255)) and the alpha channel of the texture.

Parameters

texture	Texture to be drawn.
destPos	Upper left 2d destination position where the image will be drawn.
sourceRect	Source rectangle in the image.
clipRect	Pointer to rectangle on the screen where the image is clipped to. If this pointer is NULL the image is not clipped.
color	Color with which the image is drawn. If the color equals Color(255,255,255,255) it is ignored. Note that the alpha component is used: If alpha is other than 255, the image will be transparent.
useAlphaChannelOfTexture	If true, the alpha channel of the texture is used to draw the image.

◆ draw2DImage() [3/3]

virtual void irr::video::IVideoDriver::draw2DImage	(	const video::ITexture *	texture,
		const core::rect< s32 > &	destRect,
		const core::rect< s32 > &	sourceRect,
		const core::rect< s32 > *	clipRect = `0`,
		const video::SColor *const	colors = `0`,
		bool	useAlphaChannelOfTexture = `false`
	)

pure virtual

Draws a part of the texture into the rectangle. Note that colors must be an array of 4 colors if used.

Suggested and first implemented by zola.

Parameters

texture	The texture to draw from
destRect	The rectangle to draw into
sourceRect	The rectangle denoting a part of the texture
clipRect	Clips the destination rectangle (may be 0)
colors	Array of 4 colors denoting the color values of the corners of the destRect
useAlphaChannelOfTexture	True if alpha channel will be blended.

◆ draw2DImageBatch() [1/2]

virtual void irr::video::IVideoDriver::draw2DImageBatch	(	const video::ITexture *	texture,
		const core::position2d< s32 > &	pos,
		const core::array< core::rect< s32 > > &	sourceRects,
		const core::array< s32 > &	indices,
		s32	kerningWidth = `0`,
		const core::rect< s32 > *	clipRect = `0`,
		SColor	color = `SColor(255, 255, 255, 255)`,
		bool	useAlphaChannelOfTexture = `false`
	)

pure virtual

Draws a set of 2d images, using a color and the alpha channel of the texture.

The images are drawn beginning at pos and concatenated in one line. All drawings are clipped against clipRect (if != 0). The subtextures are defined by the array of sourceRects and are chosen by the indices given.

Parameters

texture	Texture to be drawn.
pos	Upper left 2d destination position where the image will be drawn.
sourceRects	Source rectangles of the image.
indices	List of indices which choose the actual rectangle used each time.
kerningWidth	Offset to Position on X
clipRect	Pointer to rectangle on the screen where the image is clipped to. If this pointer is 0 then the image is not clipped.
color	Color with which the image is drawn. Note that the alpha component is used. If alpha is other than 255, the image will be transparent.
useAlphaChannelOfTexture	If true, the alpha channel of the texture is used to draw the image.

◆ draw2DImageBatch() [2/2]

virtual void irr::video::IVideoDriver::draw2DImageBatch	(	const video::ITexture *	texture,
		const core::array< core::position2d< s32 > > &	positions,
		const core::array< core::rect< s32 > > &	sourceRects,
		const core::rect< s32 > *	clipRect = `0`,
		SColor	color = `SColor(255, 255, 255, 255)`,
		bool	useAlphaChannelOfTexture = `false`
	)

pure virtual

Draws a set of 2d images, using a color and the alpha channel of the texture.

All drawings are clipped against clipRect (if != 0). The subtextures are defined by the array of sourceRects and are positioned using the array of positions.

Parameters

texture	Texture to be drawn.
positions	Array of upper left 2d destinations where the images will be drawn.
sourceRects	Source rectangles of the image.
clipRect	Pointer to rectangle on the screen where the images are clipped to. If this pointer is 0 then the image is not clipped.
color	Color with which the image is drawn. Note that the alpha component is used. If alpha is other than 255, the image will be transparent.
useAlphaChannelOfTexture	If true, the alpha channel of the texture is used to draw the image.

◆ draw2DLine()

virtual void irr::video::IVideoDriver::draw2DLine	(	const core::position2d< s32 > &	start,
		const core::position2d< s32 > &	end,
		SColor	color = `SColor(255, 255, 255, 255)`
	)

pure virtual

Draws a 2d line.

In theory both start and end will be included in coloring. BUG: Currently hardware drivers (d3d/opengl) ignore the last pixel (they use the so called "diamond exit rule" for drawing lines).

Parameters

start	Screen coordinates of the start of the line in pixels.
end	Screen coordinates of the start of the line in pixels.
color	Color of the line to draw.

◆ draw2DPolygon()

virtual void irr::video::IVideoDriver::draw2DPolygon	(	core::position2d< s32 >	center,
		f32	radius,
		video::SColor	color = `SColor(100, 255, 255, 255)`,
		s32	vertexCount = `10`
	)

pure virtual

Draws a non filled concyclic regular 2d polygon.

This method can be used to draw circles, but also triangles, tetragons, pentagons, hexagons, heptagons, octagons, enneagons, decagons, hendecagons, dodecagon, triskaidecagons, etc. I think you'll got it now. And all this by simply specifying the vertex count. Welcome to the wonders of geometry.

Parameters

center	Position of center of circle (pixels).
radius	Radius of circle in pixels.
color	Color of the circle.
vertexCount	Amount of vertices of the polygon. Specify 2 to draw a line, 3 to draw a triangle, 4 for tetragons and a lot (>10) for nearly a circle.

◆ draw2DRectangle() [1/2]

virtual void irr::video::IVideoDriver::draw2DRectangle	(	SColor	color,
		const core::rect< s32 > &	pos,
		const core::rect< s32 > *	clip = `0`
	)

pure virtual

Draws a 2d rectangle.

Parameters

color	Color of the rectangle to draw. The alpha component will not be ignored and specifies how transparent the rectangle will be.
pos	Position of the rectangle.
clip	Pointer to rectangle against which the rectangle will be clipped. If the pointer is null, no clipping will be performed.

◆ draw2DRectangle() [2/2]

virtual void irr::video::IVideoDriver::draw2DRectangle	(	const core::rect< s32 > &	pos,
		SColor	colorLeftUp,
		SColor	colorRightUp,
		SColor	colorLeftDown,
		SColor	colorRightDown,
		const core::rect< s32 > *	clip = `0`
	)

pure virtual

Draws a 2d rectangle with a gradient.

Parameters

colorLeftUp	Color of the upper left corner to draw. The alpha component will not be ignored and specifies how transparent the rectangle will be.
colorRightUp	Color of the upper right corner to draw. The alpha component will not be ignored and specifies how transparent the rectangle will be.
colorLeftDown	Color of the lower left corner to draw. The alpha component will not be ignored and specifies how transparent the rectangle will be.
colorRightDown	Color of the lower right corner to draw. The alpha component will not be ignored and specifies how transparent the rectangle will be.
pos	Position of the rectangle.
clip	Pointer to rectangle against which the rectangle will be clipped. If the pointer is null, no clipping will be performed.

◆ draw2DRectangleOutline()

virtual void irr::video::IVideoDriver::draw2DRectangleOutline	(	const core::recti &	pos,
		SColor	color = `SColor(255, 255, 255, 255)`
	)

pure virtual

Draws the outline of a 2D rectangle.

Parameters

pos	Position of the rectangle.
color	Color of the rectangle to draw. The alpha component specifies how transparent the rectangle outline will be.

◆ draw2DVertexPrimitiveList()

virtual void irr::video::IVideoDriver::draw2DVertexPrimitiveList	(	const void *	vertices,
		u32	vertexCount,
		const void *	indexList,
		u32	primCount,
		E_VERTEX_TYPE	vType = `EVT_STANDARD`,
		scene::E_PRIMITIVE_TYPE	pType = `scene::EPT_TRIANGLES`,
		E_INDEX_TYPE	iType = `EIT_16BIT`
	)

pure virtual

Draws a vertex primitive list in 2d.

Compared to the general (3d) version of this method, this one sets up a 2d render mode, and uses only x and y of vectors. Note that, depending on the index type, some vertices might be not accessible through the index list. The limit is at 65535 vertices for 16bit indices. Please note that currently not all primitives are available for all drivers, and some might be emulated via triangle renders. This function is not available for the sw drivers.

Parameters

vertices	Pointer to array of vertices.
vertexCount	Amount of vertices in the array.
indexList	Pointer to array of indices. These define the vertices used for each primitive. Depending on the pType, indices are interpreted as single objects (for point like primitives), pairs (for lines), triplets (for triangles), or quads.
primCount	Amount of Primitives
vType	Vertex type, e.g. video::EVT_STANDARD for S3DVertex.
pType	Primitive type, e.g. scene::EPT_TRIANGLE_FAN for a triangle fan.
iType	Index type, e.g. video::EIT_16BIT for 16bit indices.

◆ draw3DBox()

virtual void irr::video::IVideoDriver::draw3DBox	(	const core::aabbox3d< f32 > &	box,
		SColor	color = `SColor(255, 255, 255, 255)`
	)

pure virtual

Draws a 3d axis aligned box.

This method simply calls draw3DLine for the edges of the box. Note that the box is drawn using the current transformation matrix and material. So if you need to draw it independently of the current transformation, use

driver->setMaterial(someMaterial);

driver->setTransform(video::ETS_WORLD, core::IdentityMatrix);

for some properly set up material before drawing the box.

Parameters

box	The axis aligned box to draw
color	Color to use while drawing the box.

◆ draw3DLine()

virtual void irr::video::IVideoDriver::draw3DLine	(	const core::vector3df &	start,
		const core::vector3df &	end,
		SColor	color = `SColor(255, 255, 255, 255)`
	)

pure virtual

Draws a 3d line.

For some implementations, this method simply calls drawVertexPrimitiveList for some triangles. Note that the line is drawn using the current transformation matrix and material. So if you need to draw the 3D line independently of the current transformation, use

driver->setMaterial(someMaterial);

driver->setTransform(video::ETS_WORLD, core::IdentityMatrix);

for some properly set up material before drawing the line. Some drivers support line thickness set in the material.

Parameters

start	Start of the 3d line.
end	End of the 3d line.
color	Color of the line.

◆ draw3DTriangle()

virtual void irr::video::IVideoDriver::draw3DTriangle	(	const core::triangle3df &	triangle,
		SColor	color = `SColor(255, 255, 255, 255)`
	)

pure virtual

Draws a 3d triangle.

This method calls drawVertexPrimitiveList for some triangles. This method works with all drivers because it simply calls drawVertexPrimitiveList, but it is hence not very fast. Note that the triangle is drawn using the current transformation matrix and material. So if you need to draw it independently of the current transformation, use

driver->setMaterial(someMaterial);

driver->setTransform(video::ETS_WORLD, core::IdentityMatrix);

for some properly set up material before drawing the triangle.

Parameters

triangle	The triangle to draw.
color	Color of the line.

◆ drawIndexedTriangleFan() [1/3]

void irr::video::IVideoDriver::drawIndexedTriangleFan	(	const S3DVertex *	vertices,
		u32	vertexCount,
		const u16 *	indexList,
		u32	triangleCount
	)

inline

Draws an indexed triangle fan.

Note that there may be at maximum 65536 vertices, because the index list is an array of 16 bit values each with a maximum value of 65536. If there are more than 65536 vertices in the list, results of this operation are not defined.

Parameters

vertices	Pointer to array of vertices.
vertexCount	Amount of vertices in the array.
indexList	Pointer to array of indices.
triangleCount	Amount of Triangles. Usually amount of indices - 2.

Definition at line 701 of file IVideoDriver.h.

                 {
                         drawVertexPrimitiveList(vertices, vertexCount, indexList, triangleCount, EVT_STANDARD, scene::EPT_TRIANGLE_FAN, EIT_16BIT);
                 }

◆ drawIndexedTriangleFan() [2/3]

void irr::video::IVideoDriver::drawIndexedTriangleFan	(	const S3DVertex2TCoords *	vertices,
		u32	vertexCount,
		const u16 *	indexList,
		u32	triangleCount
	)

inline

Draws an indexed triangle fan.

Note that there may be at maximum 65536 vertices, because the index list is an array of 16 bit values each with a maximum value of 65536. If there are more than 65536 vertices in the list, results of this operation are not defined.

Parameters

vertices	Pointer to array of vertices.
vertexCount	Amount of vertices in the array.
indexList	Pointer to array of indices.
triangleCount	Amount of Triangles. Usually amount of indices - 2.

Definition at line 716 of file IVideoDriver.h.

                 {
                         drawVertexPrimitiveList(vertices, vertexCount, indexList, triangleCount, EVT_2TCOORDS, scene::EPT_TRIANGLE_FAN, EIT_16BIT);
                 }

◆ drawIndexedTriangleFan() [3/3]

void irr::video::IVideoDriver::drawIndexedTriangleFan	(	const S3DVertexTangents *	vertices,
		u32	vertexCount,
		const u16 *	indexList,
		u32	triangleCount
	)

inline

Draws an indexed triangle fan.

Note that there may be at maximum 65536 vertices, because the index list is an array of 16 bit values each with a maximum value of 65536. If there are more than 65536 vertices in the list, results of this operation are not defined.

Parameters

vertices	Pointer to array of vertices.
vertexCount	Amount of vertices in the array.
indexList	Pointer to array of indices.
triangleCount	Amount of Triangles. Usually amount of indices - 2.

Definition at line 731 of file IVideoDriver.h.

                 {
                         drawVertexPrimitiveList(vertices, vertexCount, indexList, triangleCount, EVT_TANGENTS, scene::EPT_TRIANGLE_FAN, EIT_16BIT);
                 }

◆ drawIndexedTriangleList() [1/3]

void irr::video::IVideoDriver::drawIndexedTriangleList	(	const S3DVertex *	vertices,
		u32	vertexCount,
		const u16 *	indexList,
		u32	triangleCount
	)

inline

Draws an indexed triangle list.

Note that there may be at maximum 65536 vertices, because the index list is an array of 16 bit values each with a maximum value of 65536. If there are more than 65536 vertices in the list, results of this operation are not defined.

Parameters

vertices	Pointer to array of vertices.
vertexCount	Amount of vertices in the array.
indexList	Pointer to array of indices.
triangleCount	Amount of Triangles. Usually amount of indices / 3.

Definition at line 656 of file IVideoDriver.h.

                 {
                         drawVertexPrimitiveList(vertices, vertexCount, indexList, triangleCount, EVT_STANDARD, scene::EPT_TRIANGLES, EIT_16BIT);
                 }

◆ drawIndexedTriangleList() [2/3]

void irr::video::IVideoDriver::drawIndexedTriangleList	(	const S3DVertex2TCoords *	vertices,
		u32	vertexCount,
		const u16 *	indexList,
		u32	triangleCount
	)

inline

Draws an indexed triangle list.

Note that there may be at maximum 65536 vertices, because the index list is an array of 16 bit values each with a maximum value of 65536. If there are more than 65536 vertices in the list, results of this operation are not defined.

Parameters

vertices	Pointer to array of vertices.
vertexCount	Amount of vertices in the array.
indexList	Pointer to array of indices.
triangleCount	Amount of Triangles. Usually amount of indices / 3.

Definition at line 671 of file IVideoDriver.h.

                 {
                         drawVertexPrimitiveList(vertices, vertexCount, indexList, triangleCount, EVT_2TCOORDS, scene::EPT_TRIANGLES, EIT_16BIT);
                 }

◆ drawIndexedTriangleList() [3/3]

void irr::video::IVideoDriver::drawIndexedTriangleList	(	const S3DVertexTangents *	vertices,
		u32	vertexCount,
		const u16 *	indexList,
		u32	triangleCount
	)

inline

Draws an indexed triangle list.

Note that there may be at maximum 65536 vertices, because the index list is an array of 16 bit values each with a maximum value of 65536. If there are more than 65536 vertices in the list, results of this operation are not defined.

Parameters

vertices	Pointer to array of vertices.
vertexCount	Amount of vertices in the array.
indexList	Pointer to array of indices.
triangleCount	Amount of Triangles. Usually amount of indices / 3.

Definition at line 686 of file IVideoDriver.h.

                 {
                         drawVertexPrimitiveList(vertices, vertexCount, indexList, triangleCount, EVT_TANGENTS, scene::EPT_TRIANGLES, EIT_16BIT);
                 }

◆ drawMeshBuffer()

virtual void irr::video::IVideoDriver::drawMeshBuffer ( const scene::IMeshBuffer * mb )

pure virtual

Draws a mesh buffer.

Parameters

mb	Buffer to draw

◆ drawMeshBufferNormals()

virtual void irr::video::IVideoDriver::drawMeshBufferNormals	(	const scene::IMeshBuffer *	mb,
		f32	length = `10.f`,
		SColor	color = `0xffffffff`
	)

pure virtual

Draws normals of a mesh buffer.

Parameters

mb	Buffer to draw the normals of
length	length scale factor of the normals
color	Color the normals are rendered with

◆ drawPixel()

virtual void irr::video::IVideoDriver::drawPixel	(	u32	x,
		u32	y,
		const SColor &	color
	)

pure virtual

Draws a pixel.

Parameters

x	The x-position of the pixel.
y	The y-position of the pixel.
color	Color of the pixel to draw.

◆ drawStencilShadow()

virtual void irr::video::IVideoDriver::drawStencilShadow	(	bool	clearStencilBuffer = `false`,
		video::SColor	leftUpEdge = `video::SColor(255, 0, 0, 0)`,
		video::SColor	rightUpEdge = `video::SColor(255, 0, 0, 0)`,
		video::SColor	leftDownEdge = `video::SColor(255, 0, 0, 0)`,
		video::SColor	rightDownEdge = `video::SColor(255, 0, 0, 0)`
	)

pure virtual

Fills the stencil shadow with color.

After the shadow volume has been drawn into the stencil buffer using IVideoDriver::drawStencilShadowVolume(), use this to draw the color of the shadow. Please note that the code for the opengl version of the method is based on free code sent in by Philipp Dortmann, lots of thanks go to him!

Parameters

clearStencilBuffer	Set this to false, if you want to draw every shadow with the same color, and only want to call drawStencilShadow() once after all shadow volumes have been drawn. Set this to true, if you want to paint every shadow with its own color.
leftUpEdge	Color of the shadow in the upper left corner of screen.
rightUpEdge	Color of the shadow in the upper right corner of screen.
leftDownEdge	Color of the shadow in the lower left corner of screen.
rightDownEdge	Color of the shadow in the lower right corner of screen.

◆ drawStencilShadowVolume()

virtual void irr::video::IVideoDriver::drawStencilShadowVolume	(	const core::array< core::vector3df > &	triangles,
		bool	zfail = `true`,
		u32	debugDataVisible = `0`
	)

pure virtual

Draws a shadow volume into the stencil buffer.

To draw a stencil shadow, do this: First, draw all geometry. Then use this method, to draw the shadow volume. Then, use IVideoDriver::drawStencilShadow() to visualize the shadow. Please note that the code for the opengl version of the method is based on free code sent in by Philipp Dortmann, lots of thanks go to him!

Parameters

triangles	Array of 3d vectors, specifying the shadow volume.
zfail	If set to true, zfail method is used, otherwise zpass.
debugDataVisible	The debug data that is enabled for this shadow node

◆ drawVertexPrimitiveList()

virtual void irr::video::IVideoDriver::drawVertexPrimitiveList	(	const void *	vertices,
		u32	vertexCount,
		const void *	indexList,
		u32	primCount,
		E_VERTEX_TYPE	vType = `EVT_STANDARD`,
		scene::E_PRIMITIVE_TYPE	pType = `scene::EPT_TRIANGLES`,
		E_INDEX_TYPE	iType = `EIT_16BIT`
	)

pure virtual

Draws a vertex primitive list.

Note that, depending on the index type, some vertices might be not accessible through the index list. The limit is at 65535 vertices for 16bit indices. Please note that currently not all primitives are available for all drivers, and some might be emulated via triangle renders.

Parameters

vertices	Pointer to array of vertices.
vertexCount	Amount of vertices in the array.
indexList	Pointer to array of indices. These define the vertices used for each primitive. Depending on the pType, indices are interpreted as single objects (for point like primitives), pairs (for lines), triplets (for triangles), or quads.
primCount	Amount of Primitives
vType	Vertex type, e.g. video::EVT_STANDARD for S3DVertex.
pType	Primitive type, e.g. scene::EPT_TRIANGLE_FAN for a triangle fan.
iType	Index type, e.g. video::EIT_16BIT for 16bit indices.

◆ enableClipPlane()

virtual void irr::video::IVideoDriver::enableClipPlane	(	u32	index,
		bool	enable
	)

pure virtual

Enable or disable a clipping plane.

There are at least 6 clipping planes available for the user to set at will.

Parameters

index	The plane index. Must be between 0 and MaxUserClipPlanes.
enable	If true, enable the clipping plane else disable it.

◆ enableMaterial2D()

virtual void irr::video::IVideoDriver::enableMaterial2D ( bool enable = true )

pure virtual

Enable the 2d override material.

Parameters

enable Flag which tells whether the material shall be enabled or disabled.

◆ endScene()

virtual bool irr::video::IVideoDriver::endScene ( )

pure virtual

Presents the rendered image to the screen.

Applications must call this method after performing any rendering.

Returns: False if failed and true if succeeded.

◆ fillMaterialStructureFromAttributes()

virtual void irr::video::IVideoDriver::fillMaterialStructureFromAttributes	(	video::SMaterial &	outMaterial,
		io::IAttributes *	attributes
	)

pure virtual

Fills an SMaterial structure from attributes.

Please note that for setting material types of the material, the video driver will need to query the material renderers for their names, so all non built-in materials must have been created before calling this method.

Parameters

outMaterial	The material to set the properties for.
attributes	The attributes to read from.

◆ findTexture()

virtual video::ITexture* irr::video::IVideoDriver::findTexture ( const io::path & filename )

pure virtual

Check if the image is already loaded.

Works similar to getTexture(), but does not load the texture if it is not currently loaded.

Parameters

filename Name of the texture.

Returns: Pointer to loaded texture, or 0 if not found.

◆ getAmbientLight()

virtual const SColorf& irr::video::IVideoDriver::getAmbientLight ( ) const

pure virtual

Get the global ambient light currently used by the driver.

◆ getColorFormat()

virtual ECOLOR_FORMAT irr::video::IVideoDriver::getColorFormat ( ) const

pure virtual

Get the current color format of the color buffer.

Returns: Color format of the color buffer.

◆ getCurrentRenderTargetSize()

virtual const core::dimension2d<u32>& irr::video::IVideoDriver::getCurrentRenderTargetSize ( ) const

pure virtual

Get the size of the current render target.

This method will return the screen size if the driver doesn't support render to texture, or if the current render target is the screen.

Returns: Size of render target or screen/window

◆ getDriverAttributes()

virtual const io::IAttributes& irr::video::IVideoDriver::getDriverAttributes ( ) const

pure virtual

Get attributes of the actual video driver.

The following names can be queried for the given types: MaxTextures (int) The maximum number of simultaneous textures supported by the driver. This can be less than the supported number of textures of the driver. Use IRR_MATERIAL_MAX_TEXTURES to adapt the number. MaxSupportedTextures (int) The maximum number of simultaneous textures supported by the fixed function pipeline of the (hw) driver. The actual supported number of textures supported by the engine can be lower. MaxLights (int) Number of hardware lights supported in the fixed function pipeline of the driver, typically 6-8. Use light manager or deferred shading for more. MaxAnisotropy (int) Number of anisotropy levels supported for filtering. At least 1, max is typically at 16 or 32. MaxUserClipPlanes (int) Number of additional clip planes, which can be set by the user via dedicated driver methods. MaxAuxBuffers (int) Special render buffers, which are currently not really usable inside Irrlicht. Only supported by OpenGL MaxMultipleRenderTargets (int) Number of render targets which can be bound simultaneously. Rendering to MRTs is done via shaders. MaxIndices (int) Number of indices which can be used in one render call (i.e. one mesh buffer). MaxTextureSize (int) Dimension that a texture may have, both in width and height. MaxGeometryVerticesOut (int) Number of vertices the geometry shader can output in one pass. Only OpenGL so far. MaxTextureLODBias (float) Maximum value for LOD bias. Is usually at around 16, but can be lower on some systems. Version (int) Version of the driver. Should be Major*100+Minor ShaderLanguageVersion (int) Version of the high level shader language. Should be Major*100+Minor. AntiAlias (int) Number of Samples the driver uses for each pixel. 0 and 1 means anti aliasing is off, typical values are 2,4,8,16,32

◆ getDriverType()

virtual E_DRIVER_TYPE irr::video::IVideoDriver::getDriverType ( ) const

pure virtual

Get type of video driver.

Returns: Type of driver.

◆ getDynamicLight()

virtual const SLight& irr::video::IVideoDriver::getDynamicLight ( u32 idx ) const

pure virtual

Returns light data which was previously set by IVideoDriver::addDynamicLight().

Parameters

idx	Zero based index of the light. Must be 0 or greater and smaller than IVideoDriver::getDynamicLightCount.

Returns: Light data.

◆ getDynamicLightCount()

virtual u32 irr::video::IVideoDriver::getDynamicLightCount ( ) const

pure virtual

Returns amount of dynamic lights currently set.

Returns: Amount of dynamic lights currently set

◆ getExposedVideoData()

virtual const SExposedVideoData& irr::video::IVideoDriver::getExposedVideoData ( )

pure virtual

Returns driver and operating system specific data about the IVideoDriver.

This method should only be used if the engine should be extended without having to modify the source of the engine.

Returns: Collection of device dependent pointers.

◆ getFog()

virtual void irr::video::IVideoDriver::getFog	(	SColor &	color,
		E_FOG_TYPE &	fogType,
		f32 &	start,
		f32 &	end,
		f32 &	density,
		bool &	pixelFog,
		bool &	rangeFog
	)

pure virtual

Gets the fog mode.

◆ getFPS()

virtual s32 irr::video::IVideoDriver::getFPS ( ) const

pure virtual

Returns current frames per second value.

This value is updated approximately every 1.5 seconds and is only intended to provide a rough guide to the average frame rate. It is not suitable for use in performing timing calculations or framerate independent movement.

Returns: Approximate amount of frames per second drawn.

◆ getGPUProgrammingServices()

virtual IGPUProgrammingServices* irr::video::IVideoDriver::getGPUProgrammingServices ( )

pure virtual

Gets the IGPUProgrammingServices interface.

Returns: Pointer to the IGPUProgrammingServices. Returns 0 if the video driver does not support this. For example the Software driver and the Null driver will always return 0.

◆ getImageLoader()

virtual IImageLoader* irr::video::IVideoDriver::getImageLoader ( u32 n )

pure virtual

Retrieve the given image loader.

Parameters

n	The index of the loader to retrieve. This parameter is an 0-based array index.

Returns: A pointer to the specified loader, 0 if the index is incorrect.

◆ getImageLoaderCount()

virtual u32 irr::video::IVideoDriver::getImageLoaderCount ( ) const

pure virtual

Retrieve the number of image loaders.

Returns: Number of image loaders

◆ getImageWriter()

virtual IImageWriter* irr::video::IVideoDriver::getImageWriter ( u32 n )

pure virtual

Retrieve the given image writer.

Parameters

n	The index of the writer to retrieve. This parameter is an 0-based array index.

Returns: A pointer to the specified writer, 0 if the index is incorrect.

◆ getImageWriterCount()

virtual u32 irr::video::IVideoDriver::getImageWriterCount ( ) const

pure virtual

Retrieve the number of image writers.

Returns: Number of image writers

◆ getMaterial2D()

virtual SMaterial& irr::video::IVideoDriver::getMaterial2D ( )

pure virtual

Get the 2d override material for altering its values.

The 2d override material allows to alter certain render states of the 2d methods. Not all members of SMaterial are honored, especially not MaterialType and Textures. Moreover, the zbuffer is always ignored, and lighting is always off. All other flags can be changed, though some might have to effect in most cases. Please note that you have to enable/disable this effect with enableInitMaterial2D(). This effect is costly, as it increases the number of state changes considerably. Always reset the values when done.

Returns: Material reference which should be altered to reflect the new settings.

◆ getMaterialRenderer()

virtual IMaterialRenderer* irr::video::IVideoDriver::getMaterialRenderer ( u32 idx ) const

pure virtual

Get access to a material renderer by index.

Parameters

idx	Id of the material renderer. Can be a value of the E_MATERIAL_TYPE enum or a value which was returned by addMaterialRenderer().

Returns: Pointer to material renderer or null if not existing.

◆ getMaterialRendererCount()

virtual u32 irr::video::IVideoDriver::getMaterialRendererCount ( ) const

pure virtual

Get amount of currently available material renderers.

Returns: Amount of currently available material renderers.

◆ getMaterialRendererName()

virtual const c8* irr::video::IVideoDriver::getMaterialRendererName ( u32 idx ) const

pure virtual

Get name of a material renderer.

This string can, e.g., be used to test if a specific renderer already has been registered/created, or use this string to store data about materials: This returned name will be also used when serializing materials.

Parameters

idx	Id of the material renderer. Can be a value of the E_MATERIAL_TYPE enum or a value which was returned by addMaterialRenderer().

Returns: String with the name of the renderer, or 0 if not exisiting

◆ getMaximalDynamicLightAmount()

virtual u32 irr::video::IVideoDriver::getMaximalDynamicLightAmount ( ) const

pure virtual

Returns the maximal amount of dynamic lights the device can handle.

Returns: Maximal amount of dynamic lights.

◆ getMaximalPrimitiveCount()

virtual u32 irr::video::IVideoDriver::getMaximalPrimitiveCount ( ) const

pure virtual

Returns the maximum amount of primitives.

(mostly vertices) which the device is able to render with one drawVertexPrimitiveList call.

Returns: Maximum amount of primitives.

◆ getMaxTextureSize()

virtual core::dimension2du irr::video::IVideoDriver::getMaxTextureSize ( ) const

pure virtual

Get the maximum texture size supported.

◆ getMeshManipulator()

virtual scene::IMeshManipulator* irr::video::IVideoDriver::getMeshManipulator ( )

pure virtual

Returns a pointer to the mesh manipulator.

◆ getName()

virtual const wchar_t* irr::video::IVideoDriver::getName ( ) const

pure virtual

Gets name of this video driver.

Returns: Returns the name of the video driver, e.g. in case of the Direct3D8 driver, it would return "Direct3D 8.1".

◆ getOcclusionQueryResult()

virtual u32 irr::video::IVideoDriver::getOcclusionQueryResult ( scene::ISceneNode * node ) const

pure virtual

Return query result.

Return value is the number of visible pixels/fragments. The value is a safe approximation, i.e. can be larger than the actual value of pixels.

◆ getOverrideMaterial()

virtual SOverrideMaterial& irr::video::IVideoDriver::getOverrideMaterial ( )

pure virtual

Get the global Material, which might override local materials.

Depending on the enable flags, values from this Material are used to override those of local materials of some meshbuffer being rendered.

Returns: Reference to the Override Material.

◆ getPrimitiveCountDrawn()

virtual u32 irr::video::IVideoDriver::getPrimitiveCountDrawn ( u32 mode = 0 ) const

pure virtual

Returns amount of primitives (mostly triangles) which were drawn in the last frame.

Together with getFPS() very useful method for statistics.

Parameters

mode	Defines if the primitives drawn are accumulated or counted per frame.

Returns: Amount of primitives drawn in the last frame.

◆ getScreenSize()

virtual const core::dimension2d<u32>& irr::video::IVideoDriver::getScreenSize ( ) const

pure virtual

Get the size of the screen or render window.

Returns: Size of screen or render window.

◆ getShaderConstant()

virtual SShaderConstant* irr::video::IVideoDriver::getShaderConstant ( irr::u32 num )

inlinevirtual

Definition at line 1573 of file IVideoDriver.h.

1573 { return 0; }

◆ getShaderConstantSize()

virtual irr::u32 irr::video::IVideoDriver::getShaderConstantSize ( ) const

inlinevirtual

Definition at line 1575 of file IVideoDriver.h.

1575 { return 0; }

◆ getTexture() [1/2]

virtual ITexture* irr::video::IVideoDriver::getTexture ( const io::path & filename )

pure virtual

Get access to a named texture.

Loads the texture from disk if it is not already loaded and generates mipmap levels if desired. Texture loading can be influenced using the setTextureCreationFlag() method. The texture can be in several imageformats, such as BMP, JPG, TGA, PCX, PNG, and PSD.

Parameters

filename Filename of the texture to be loaded.

Returns: Pointer to the texture, or 0 if the texture could not be loaded. This pointer should not be dropped. See IReferenceCounted::drop() for more information.

◆ getTexture() [2/2]

virtual ITexture* irr::video::IVideoDriver::getTexture ( io::IReadFile * file )

pure virtual

Get access to a named texture.

Loads the texture from disk if it is not already loaded and generates mipmap levels if desired. Texture loading can be influenced using the setTextureCreationFlag() method. The texture can be in several imageformats, such as BMP, JPG, TGA, PCX, PNG, and PSD.

Parameters

file	Pointer to an already opened file.

Returns: Pointer to the texture, or 0 if the texture could not be loaded. This pointer should not be dropped. See IReferenceCounted::drop() for more information.

◆ getTextureByIndex()

virtual ITexture* irr::video::IVideoDriver::getTextureByIndex ( u32 index )

pure virtual

Returns a texture by index.

Parameters

index Index of the texture, must be smaller than getTextureCount() Please note that this index might change when adding or removing textures

Returns: Pointer to the texture, or 0 if the texture was not set or index is out of bounds. This pointer should not be dropped. See IReferenceCounted::drop() for more information.

◆ getTextureCount()

virtual u32 irr::video::IVideoDriver::getTextureCount ( ) const

pure virtual

Returns amount of textures currently loaded.

Returns: Amount of textures currently loaded

◆ getTextureCreationFlag()

virtual bool irr::video::IVideoDriver::getTextureCreationFlag ( E_TEXTURE_CREATION_FLAG flag ) const

pure virtual

Returns if a texture creation flag is enabled or disabled.

You can change this value using setTextureCreationFlag().

Parameters

flag	Texture creation flag.

Returns: The current texture creation flag enabled mode.

◆ getTransform()

virtual const core::matrix4& irr::video::IVideoDriver::getTransform ( E_TRANSFORMATION_STATE state ) const

pure virtual

Returns the transformation set by setTransform.

Parameters

state Transformation type to query

Returns: Matrix describing the transformation.

◆ getVendorInfo()

virtual core::stringc irr::video::IVideoDriver::getVendorInfo ( )

pure virtual

Get the graphics card vendor name.

◆ getViewPort()

virtual const core::rect<s32>& irr::video::IVideoDriver::getViewPort ( ) const

pure virtual

Gets the area of the current viewport.

Returns: Rectangle of the current viewport.

◆ getVirtualScreenSize()

virtual core::dimension2du irr::video::IVideoDriver::getVirtualScreenSize ( ) const

inlinevirtual

Definition at line 1581 of file IVideoDriver.h.

1581 { return core::dimension2du(0, 0); }

irr::core::dimension2du

dimension2d< u32 > dimension2du

Typedef for an unsigned integer dimension.

Definition: dimension2d.h:212

◆ makeColorKeyTexture() [1/2]

virtual void irr::video::IVideoDriver::makeColorKeyTexture	(	video::ITexture *	texture,
		video::SColor	color,
		bool	zeroTexels = `false`
	)		const

pure virtual

Sets a boolean alpha channel on the texture based on a color key.

This makes the texture fully transparent at the texels where this color key can be found when using for example draw2DImage with useAlphachannel==true. The alpha of other texels is not modified.

Parameters

texture	Texture whose alpha channel is modified.
color	Color key color. Every texel with this color will become fully transparent as described above. Please note that the colors of a texture may be converted when loading it, so the color values may not be exactly the same in the engine and for example in picture edit programs. To avoid this problem, you could use the makeColorKeyTexture method, which takes the position of a pixel instead a color value.
zeroTexels

Deprecated:: If set to true, then any texels that match the color key will have their color, as well as their alpha, set to zero (i.e. black). This behavior matches the legacy (buggy) behavior prior to release 1.5 and is provided for backwards compatibility only. This parameter may be removed by Irrlicht 1.9.

◆ makeColorKeyTexture() [2/2]

virtual void irr::video::IVideoDriver::makeColorKeyTexture	(	video::ITexture *	texture,
		core::position2d< s32 >	colorKeyPixelPos,
		bool	zeroTexels = `false`
	)		const

pure virtual

Sets a boolean alpha channel on the texture based on the color at a position.

This makes the texture fully transparent at the texels where the color key can be found when using for example draw2DImage with useAlphachannel==true. The alpha of other texels is not modified.

Parameters

texture	Texture whose alpha channel is modified.
colorKeyPixelPos	Position of a pixel with the color key color. Every texel with this color will become fully transparent as described above.
zeroTexels

Deprecated:: If set to true, then any texels that match the color key will have their color, as well as their alpha, set to zero (i.e. black). This behavior matches the legacy (buggy) behavior prior to release 1.5 and is provided for backwards compatibility only. This parameter may be removed by Irrlicht 1.9.

◆ makeNormalMapTexture()

virtual void irr::video::IVideoDriver::makeNormalMapTexture	(	video::ITexture *	texture,
		f32	amplitude = `1.0f`
	)		const

pure virtual

Creates a normal map from a height map texture.

As input is considered to be a height map the texture is read like:

For a 32-bit texture only the red channel is regarded
For a 16-bit texture the rgb-values are averaged. Output channels red/green for X/Y and blue for up (Z). For a 32-bit texture we store additionally the height value in the alpha channel. This value is used by the video::EMT_PARALLAX_MAP_SOLID material and similar materials. On the borders the texture is considered to repeat.
Parameters

texture Height map texture which is converted to a normal map.

amplitude Constant value by which the height information is multiplied.

◆ needsTransparentRenderPass()

virtual bool irr::video::IVideoDriver::needsTransparentRenderPass ( const irr::video::SMaterial & material ) const

pure virtual

Used by some SceneNodes to check if a material should be rendered in the transparent render pass.

◆ OnResize()

virtual void irr::video::IVideoDriver::OnResize ( const core::dimension2d< u32 > & size )

pure virtual

Event handler for resize events. Only used by the engine internally.

Used to notify the driver that the window was resized. Usually, there is no need to call this method.

◆ queryFeature()

virtual bool irr::video::IVideoDriver::queryFeature ( E_VIDEO_DRIVER_FEATURE feature ) const

pure virtual

Queries the features of the driver.

Returns true if a feature is available

Parameters

feature Feature to query.

Returns: True if the feature is available, false if not.

◆ queryTextureFormat()

virtual bool irr::video::IVideoDriver::queryTextureFormat ( ECOLOR_FORMAT format ) const

pure virtual

Check if the driver supports creating textures with the given color format.

Returns: True if the format is available, false if not.

◆ removeAllHardwareBuffers()

virtual void irr::video::IVideoDriver::removeAllHardwareBuffers ( )

pure virtual

Remove all hardware buffers.

◆ removeAllOcclusionQueries()

virtual void irr::video::IVideoDriver::removeAllOcclusionQueries ( )

pure virtual

Remove all occlusion queries.

◆ removeAllRenderTargets()

virtual void irr::video::IVideoDriver::removeAllRenderTargets ( )

pure virtual

Remove all render targets.

◆ removeAllTextures()

virtual void irr::video::IVideoDriver::removeAllTextures ( )

pure virtual

Removes all textures from the texture cache and deletes them.

This method can free a lot of memory! Please note that after calling this, the pointer to the ITexture may no longer be valid, if it was not grabbed before by other parts of the engine for storing it longer. So it is a good idea to set all materials which are using this texture to 0 or another texture first.

◆ removeHardwareBuffer()

virtual void irr::video::IVideoDriver::removeHardwareBuffer ( const scene::IMeshBuffer * mb )

pure virtual

Remove hardware buffer.

◆ removeMaterialRenderer()

virtual bool irr::video::IVideoDriver::removeMaterialRenderer ( u32 idx )

inlinevirtual

Definition at line 1534 of file IVideoDriver.h.

1534 { return false; }

◆ removeOcclusionQuery()

virtual void irr::video::IVideoDriver::removeOcclusionQuery ( scene::ISceneNode * node )

pure virtual

Remove occlusion query.

◆ removeRenderTarget()

virtual void irr::video::IVideoDriver::removeRenderTarget ( IRenderTarget * renderTarget )

pure virtual

Remove render target.

◆ removeTexture()

virtual void irr::video::IVideoDriver::removeTexture ( ITexture * texture )

pure virtual

Removes a texture from the texture cache and deletes it.

This method can free a lot of memory! Please note that after calling this, the pointer to the ITexture may no longer be valid, if it was not grabbed before by other parts of the engine for storing it longer. So it is a good idea to set all materials which are using this texture to 0 or another texture first.

Parameters

texture Texture to delete from the engine cache.

◆ renameTexture()

virtual void irr::video::IVideoDriver::renameTexture	(	ITexture *	texture,
		const io::path &	newName
	)

pure virtual

Renames a texture.

Parameters

texture	Pointer to the texture to rename.
newName	New name for the texture. This should be a unique name.

◆ runAllOcclusionQueries()

virtual void irr::video::IVideoDriver::runAllOcclusionQueries ( bool visible = false )

pure virtual

Run all occlusion queries. Draws all meshes stored in queries.

If the meshes shall not be rendered visible, use overrideMaterial to disable the color and depth buffer.

◆ runOcclusionQuery()

virtual void irr::video::IVideoDriver::runOcclusionQuery	(	scene::ISceneNode *	node,
		bool	visible = `false`
	)

pure virtual

Run occlusion query. Draws mesh stored in query.

If the mesh shall not be rendered visible, use overrideMaterial to disable the color and depth buffer.

◆ setAllowZWriteOnTransparent()

virtual void irr::video::IVideoDriver::setAllowZWriteOnTransparent ( bool flag )

pure virtual

Only used by the engine internally.

Passes the global material flag AllowZWriteOnTransparent. Use the SceneManager attribute to set this value from your app.

Parameters

flag	Default behavior is to disable ZWrite, i.e. false.

◆ setAmbientLight()

virtual void irr::video::IVideoDriver::setAmbientLight ( const SColorf & color )

pure virtual

Only used by the engine internally.

The ambient color is set in the scene manager, see scene::ISceneManager::setAmbientLight().

Parameters

color New color of the ambient light.

◆ setClipPlane()

virtual bool irr::video::IVideoDriver::setClipPlane	(	u32	index,
		const core::plane3df &	plane,
		bool	enable = `false`
	)

pure virtual

Set or unset a clipping plane.

There are at least 6 clipping planes available for the user to set at will.

Parameters

index	The plane index. Must be between 0 and MaxUserClipPlanes.
plane	The plane itself.
enable	If true, enable the clipping plane else disable it.

Returns: True if the clipping plane is usable.

◆ setFog()

virtual void irr::video::IVideoDriver::setFog	(	SColor	color = `SColor(0, 255, 255, 255)`,
		E_FOG_TYPE	fogType = `EFT_FOG_LINEAR`,
		f32	start = `50.0f`,
		f32	end = `100.0f`,
		f32	density = `0.01f`,
		bool	pixelFog = `false`,
		bool	rangeFog = `false`
	)

pure virtual

Sets the fog mode.

These are global values attached to each 3d object rendered, which has the fog flag enabled in its material.

Parameters

color	Color of the fog
fogType	Type of fog used
start	Only used in linear fog mode (linearFog=true). Specifies where fog starts.
end	Only used in linear fog mode (linearFog=true). Specifies where fog ends.
density	Only used in exponential fog mode (linearFog=false). Must be a value between 0 and 1.
pixelFog	Set this to false for vertex fog, and true if you want per-pixel fog.
rangeFog	Set this to true to enable range-based vertex fog. The distance from the viewer is used to compute the fog, not the z-coordinate. This is better, but slower. This might not be available with all drivers and fog settings.

◆ setMaterial()

virtual void irr::video::IVideoDriver::setMaterial ( const SMaterial & material )

pure virtual

Sets a material.

All 3d drawing functions will draw geometry using this material thereafter.

Parameters

material Material to be used from now on.

◆ setMaterialRendererName()

virtual void irr::video::IVideoDriver::setMaterialRendererName	(	s32	idx,
		const c8 *	name
	)

pure virtual

Sets the name of a material renderer.

Will have no effect on built-in material renderers.

Parameters

idx	Id of the material renderer. Can be a value of the E_MATERIAL_TYPE enum or a value which was returned by addMaterialRenderer().
name	New name of the material renderer.

◆ setMinHardwareBufferVertexCount()

virtual void irr::video::IVideoDriver::setMinHardwareBufferVertexCount ( u32 count )

pure virtual

Set the minimum number of vertices for which a hw buffer will be created.

Parameters

count Number of vertices to set as minimum.

◆ setRenderTarget() [1/2]

virtual bool irr::video::IVideoDriver::setRenderTarget	(	ITexture *	texture,
		u16	clearFlag = `ECBF_COLOR\|ECBF_DEPTH`,
		SColor	clearColor = `SColor(255, 0, 0, 0)`,
		f32	clearDepth = `1.f`,
		u8	clearStencil = `0`
	)

pure virtual

Sets a new render target.

This will only work if the driver supports the EVDF_RENDER_TO_TARGET feature, which can be queried with queryFeature(). Usually, rendering to textures is done in this way:

// create render target
ITexture* target = driver->addRenderTargetTexture(core::dimension2d<u32>(128,128), "rtt1");
// ...
driver->setRenderTarget(target); // set render target
// .. draw stuff here
driver->setRenderTarget(0); // set previous render target

Please note that you cannot render 3D or 2D geometry with a render target as texture on it when you are rendering the scene into this render target at the same time. It is usually only possible to render into a texture between the IVideoDriver::beginScene() and endScene() method calls.

Parameters

texture	New render target. Must be a texture created with IVideoDriver::addRenderTargetTexture(). If set to 0, it sets the previous render target which was set before the last setRenderTarget() call.
clearFlag	A combination of the E_CLEAR_BUFFER_FLAG bit-flags.
clearColor	The clear color for the color buffer.
clearDepth	The clear value for the depth buffer.
clearStencil	The clear value for the stencil buffer.

Returns: True if successful and false if not.

◆ setRenderTarget() [2/2]

bool irr::video::IVideoDriver::setRenderTarget	(	ITexture *	texture,
		bool	clearBackBuffer,
		bool	clearZBuffer,
		SColor	color = `SColor(255,0,0,0)`
	)

inline

Sets a new render target. Prefer to use the setRenderTarget function taking flags as parameter as this one can't clear the stencil buffer. It's still offered for backward compatibility.

Definition at line 577 of file IVideoDriver.h.

                 {
                         u16 flag = 0;
 
                         if (clearBackBuffer)
                                 flag |= ECBF_COLOR;
 
                         if (clearZBuffer)
                                 flag |= ECBF_DEPTH;
 
                         return setRenderTarget(texture, flag, color);
                 }

◆ setRenderTargetEx()

virtual bool irr::video::IVideoDriver::setRenderTargetEx	(	IRenderTarget *	target,
		u16	clearFlag,
		SColor	clearColor = `SColor(255, 0, 0, 0)`,
		f32	clearDepth = `1.f`,
		u8	clearStencil = `0`
	)

pure virtual

Set a render target.

This will only work if the driver supports the EVDF_RENDER_TO_TARGET feature, which can be queried with queryFeature(). Please note that you cannot render 3D or 2D geometry with a render target as texture on it when you are rendering the scene into this render target at the same time. It is usually only possible to render into a texture between the IVideoDriver::beginScene() and endScene() method calls. If you need the best performance use this method instead of setRenderTarget.

Parameters

target	Render target object.
clearFlag	A combination of the E_CLEAR_BUFFER_FLAG bit-flags.
clearColor	The clear color for the color buffer.
clearDepth	The clear value for the depth buffer.
clearStencil	The clear value for the stencil buffer.

Returns: True if successful and false if not.

◆ setTextureCreationFlag()

virtual void irr::video::IVideoDriver::setTextureCreationFlag	(	E_TEXTURE_CREATION_FLAG	flag,
		bool	enabled = `true`
	)

pure virtual

Enables or disables a texture creation flag.

These flags define how textures should be created. By changing this value, you can influence for example the speed of rendering a lot. But please note that the video drivers take this value only as recommendation. It could happen that you enable the ETCF_ALWAYS_16_BIT mode, but the driver still creates 32 bit textures.

Parameters

flag	Texture creation flag.
enabled	Specifies if the given flag should be enabled or disabled.

◆ setTransform()

virtual void irr::video::IVideoDriver::setTransform	(	E_TRANSFORMATION_STATE	state,
		const core::matrix4 &	mat
	)

pure virtual

Sets transformation matrices.

Parameters

state	Transformation type to be set, e.g. view, world, or projection.
mat	Matrix describing the transformation.

◆ setViewPort()

virtual void irr::video::IVideoDriver::setViewPort ( const core::rect< s32 > & area )

pure virtual

Sets a new viewport.

Every rendering operation is done into this new area.

Parameters

area	Rectangle defining the new area of rendering operations.

◆ setVirtualScreenSize()

virtual void irr::video::IVideoDriver::setVirtualScreenSize ( const core::dimension2du & size )

inlinevirtual

Definition at line 1580 of file IVideoDriver.h.

1580 { }

◆ swapMaterialRenderers()

virtual void irr::video::IVideoDriver::swapMaterialRenderers	(	u32	idx1,
		u32	idx2,
		bool	swapNames = `true`
	)

pure virtual

Swap the material renderers used for certain id's.

Swap the IMaterialRenderers responsible for rendering specific material-id's. This means every SMaterial using a MaterialType with one of the indices involved here will now render differently.

Parameters

idx1	First material index to swap. It must already exist or nothing happens.
idx2	Second material index to swap. It must already exist or nothing happens.
swapNames	When true the renderer names also swap When false the names will stay at the original index

◆ turnLightOn()

virtual void irr::video::IVideoDriver::turnLightOn	(	s32	lightIndex,
		bool	turnOn
	)

pure virtual

Turns a dynamic light on or off

Parameters

lightIndex	the index returned by addDynamicLight
turnOn	true to turn the light on, false to turn it off

◆ updateAllOcclusionQueries()

virtual void irr::video::IVideoDriver::updateAllOcclusionQueries ( bool block = true )

pure virtual

Update all occlusion queries. Retrieves results from GPU.

If the query shall not block, set the flag to false. Update might not occur in this case, though

◆ updateOcclusionQuery()

virtual void irr::video::IVideoDriver::updateOcclusionQuery	(	scene::ISceneNode *	node,
		bool	block = `true`
	)

pure virtual

Update occlusion query. Retrieves results from GPU.

If the query shall not block, set the flag to false. Update might not occur in this case, though

◆ writeImageToFile() [1/2]

virtual bool irr::video::IVideoDriver::writeImageToFile	(	IImage *	image,
		const io::path &	filename,
		u32	param = `0`
	)

pure virtual

Writes the provided image to a file.

Requires that there is a suitable image writer registered for writing the image.

Parameters

image	Image to write.
filename	Name of the file to write.
param	Control parameter for the backend (e.g. compression level).

Returns: True on successful write.

◆ writeImageToFile() [2/2]

virtual bool irr::video::IVideoDriver::writeImageToFile	(	IImage *	image,
		io::IWriteFile *	file,
		u32	param = `0`
	)

pure virtual

Writes the provided image to a file.

Requires that there is a suitable image writer registered for writing the image.

Parameters

image	Image to write.
file	An already open io::IWriteFile object. The name will be used to determine the appropriate image writer to use.
param	Control parameter for the backend (e.g. compression level).

Returns: True on successful write.

The documentation for this class was generated from the following file:

include/irrlicht/IVideoDriver.h

texture	Height map texture which is converted to a normal map.
amplitude	Constant value by which the height information is multiplied.

Classes

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ E_SHADER_VAR_TYPE

Member Function Documentation

◆ addDynamicLight()

◆ addExternalImageLoader()

◆ addExternalImageWriter()

◆ addMaterialRenderer()

◆ addOcclusionQuery()

◆ addRenderTarget()

◆ addRenderTargetTexture()

◆ addRenderTargetTextureCubemap()

◆ addShaderConstant()

◆ addTexture() [1/3]

◆ addTexture() [2/3]

◆ addTexture() [3/3]

◆ addTextureCubemap() [1/2]

◆ addTextureCubemap() [2/2]

◆ beginScene() [1/2]

◆ beginScene() [2/2]

◆ checkDriverReset()

◆ clearBuffers() [1/2]

◆ clearBuffers() [2/2]

◆ clearShaderConstant()

◆ clearZBuffer()

◆ convertColor()

◆ createAttributesFromMaterial()

◆ createImage() [1/4]

◆ createImage() [2/4]

◆ createImage() [3/4]

◆ createImage() [4/4]

◆ createImageFromData()

◆ createImageFromFile() [1/2]

◆ createImageFromFile() [2/2]

◆ createImagesFromFile() [1/2]

◆ createImagesFromFile() [2/2]

◆ createScreenShot()

◆ deleteAllDynamicLights()

◆ disableFeature()

◆ draw2DImage() [1/3]

◆ draw2DImage() [2/3]

◆ draw2DImage() [3/3]

◆ draw2DImageBatch() [1/2]

◆ draw2DImageBatch() [2/2]

◆ draw2DLine()

◆ draw2DPolygon()

◆ draw2DRectangle() [1/2]

◆ draw2DRectangle() [2/2]

◆ draw2DRectangleOutline()

◆ draw2DVertexPrimitiveList()

◆ draw3DBox()

◆ draw3DLine()

◆ draw3DTriangle()

◆ drawIndexedTriangleFan() [1/3]

◆ drawIndexedTriangleFan() [2/3]

◆ drawIndexedTriangleFan() [3/3]

◆ drawIndexedTriangleList() [1/3]

◆ drawIndexedTriangleList() [2/3]

◆ drawIndexedTriangleList() [3/3]

◆ drawMeshBuffer()

◆ drawMeshBufferNormals()

◆ drawPixel()

◆ drawStencilShadow()

◆ drawStencilShadowVolume()

◆ drawVertexPrimitiveList()

◆ enableClipPlane()

◆ enableMaterial2D()

◆ endScene()

◆ fillMaterialStructureFromAttributes()

◆ findTexture()

◆ getAmbientLight()

◆ getColorFormat()

◆ getCurrentRenderTargetSize()

◆ getDriverAttributes()

◆ getDriverType()

◆ getDynamicLight()