Untold Engine  Beta v0.0.16
docs
U4DEngine::U4DRenderSkybox Class Reference

The U4DRenderSkybox class manages the rendering of the skybox entity. More...

Inherits U4DEngine::U4DRenderEntity.

Public Member Functions

 U4DRenderSkybox (U4DSkybox *uU4DSkybox)
 Constructor for class. More...
 
 ~U4DRenderSkybox ()
 Destructor for class.
 
bool loadMTLBuffer ()
 Loads the attributes and Uniform data. More...
 
void loadMTLTexture ()
 Loads image texture into GPU. More...
 
void updateSpaceUniforms ()
 Updates the space matrix of the entity. More...
 
void render (id< MTLRenderCommandEncoder > uRenderEncoder)
 Renders the current entity. More...
 
void createTextureObject (id< MTLTexture > &uTexture)
 Creates the texture object for the skybox. More...
 
void alignedAttributeData ()
 It aligns all attribute data. More...
 
void clearModelAttributeData ()
 clears all attributes containers More...
 
- Public Member Functions inherited from U4DEngine::U4DRenderEntity
 U4DRenderEntity ()
 Constructor for the U4DRenderEntity. More...
 
virtual ~U4DRenderEntity ()
 Destructor for the U4DRenderEntity. More...
 
void loadRenderingInformation ()
 Sends attributes information to the GPU. More...
 
virtual void loadMTLAdditionalInformation ()
 Loads additional information for different types of entities. More...
 
virtual void updateAllUniforms ()
 
virtual void updateRenderingInformation ()
 Updates the space matrix of the shadow. More...
 
virtual void modifyRenderingInformation ()
 
void createSamplerObject (id< MTLSamplerState > &uSamplerStateObject, MTLSamplerDescriptor *uSamplerDescriptor)
 Creates a sampler object required for texturing. More...
 
virtual void setGeometryLineColor (U4DVector4n &uGeometryLineColor)
 Set line color for geometric entities. More...
 
void clearRawImageData ()
 Clear the raw image data. More...
 
virtual void initTextureSamplerObjectNull ()
 Initializes texture sampler object to null. More...
 
void setIsWithinFrustum (bool uValue)
 Sets property used to determine if entity is within frustum. More...
 
void setRawImageData (std::vector< unsigned char > uRawImageData)
 
void setImageWidth (unsigned int uImageWidth)
 
void setImageHeight (unsigned int uImageHeight)
 
bool createTextureAndSamplerObjects (id< MTLTexture > &uTextureObject, id< MTLSamplerState > &uSamplerStateObject, MTLSamplerDescriptor *uSamplerDescriptor, std::string uTextureName)
 
void setPipelineForPass (std::string uPipelineName, int uRenderPassKey)
 
void removePassPipelinePair (int uRenderPassKey)
 
U4DRenderPipelineInterfacegetPipeline (int uRenderPassKey)
 

Additional Inherited Members

- Protected Attributes inherited from U4DEngine::U4DRenderEntity
id< MTLDevice > mtlDevice
 Pointer representing a Metal Device.
 
id< MTLBuffer > attributeBuffer
 Pointer to the attribute buffer.
 
id< MTLBuffer > indicesBuffer
 Pointer to the index buffer.
 
id< MTLBuffer > uniformSpaceBuffer
 Pointer to the Uniform that holds the Space matrix.
 
bool eligibleToRender
 Variable to determine if object should be rendered.
 
bool isWithinFrustum
 Variable to determine if the 3D object is within the frustum.
 
std::vector< unsigned char > rawImageData
 buffer for the raw image data of a texture
 
unsigned int imageWidth
 Width of the texture image.
 
unsigned int imageHeight
 Height of the texture image.
 
std::map< int, U4DRenderPipelineInterface * > renderPassPipelineMap
 

Detailed Description

The U4DRenderSkybox class manages the rendering of the skybox entity.

Constructor & Destructor Documentation

◆ U4DRenderSkybox()

U4DEngine::U4DRenderSkybox::U4DRenderSkybox ( U4DSkybox uU4DSkybox)

Constructor for class.

It sets the skybox entity it will manage

Member Function Documentation

◆ alignedAttributeData()

void U4DEngine::U4DRenderSkybox::alignedAttributeData ( )

It aligns all attribute data.

Aligns vertices and uv. This is necessary when using Metal

◆ clearModelAttributeData()

void U4DEngine::U4DRenderSkybox::clearModelAttributeData ( )
virtual

clears all attributes containers

clears attributes containers such as vertices and UVs

Reimplemented from U4DEngine::U4DRenderEntity.

◆ createTextureObject()

void U4DEngine::U4DRenderSkybox::createTextureObject ( id< MTLTexture > &  uTexture)
virtual

Creates the texture object for the skybox.

It computes the size of the skybox and creates a texture object for the skybox

Reimplemented from U4DEngine::U4DRenderEntity.

◆ loadMTLBuffer()

bool U4DEngine::U4DRenderSkybox::loadMTLBuffer ( )
virtual

Loads the attributes and Uniform data.

It prepares the attribute data so that it is aligned. It then loads the attributes into a buffer. It also loads uniform data into a buffer

Returns
True if loading is successful

Reimplemented from U4DEngine::U4DRenderEntity.

◆ loadMTLTexture()

void U4DEngine::U4DRenderSkybox::loadMTLTexture ( )
virtual

Loads image texture into GPU.

It creates a texture object, a texture sampler, and loads the raw data into a buffer for all 6 textures

Reimplemented from U4DEngine::U4DRenderEntity.

◆ render()

void U4DEngine::U4DRenderSkybox::render ( id< MTLRenderCommandEncoder >  uRenderEncoder)
virtual

Renders the current entity.

Updates the space matrix and any rendering flags. It encodes the pipeline, buffers and issues the draw command

Parameters
uRenderEncoderMetal encoder object for the current entity

Reimplemented from U4DEngine::U4DRenderEntity.

◆ updateSpaceUniforms()

void U4DEngine::U4DRenderSkybox::updateSpaceUniforms ( )
virtual

Updates the space matrix of the entity.

Updates the image space matrix of the entity by computing the world, view and perspective space matrix

Reimplemented from U4DEngine::U4DRenderEntity.