NAP
Public Member Functions | Public Attributes | List of all members
CubeMapFromFile Class Reference

#include <cubemapfromfile.h>

Public Member Functions

virtual ~CubeMapFromFile ()
 
 CubeMapFromFile (Core &core)
 
virtual bool init (utility::ErrorState &errorState) override
 
virtual void onDestroy () override
 
Texture2DgetSourceTexture () const
 
- Public Member Functions inherited from RenderTextureCube
 RenderTextureCube (Core &core)
 
- Public Member Functions inherited from TextureCube
 TextureCube (Core &core)
 
virtual ~TextureCube () override
 
bool init (const SurfaceDescriptor &descriptor, bool generateMipMaps, const glm::vec4 &clearColor, VkImageUsageFlags requiredFlags, utility::ErrorState &errorState)
 
const glm::vec2 getSize () const
 
int getWidth () const
 
int getHeight () const
 
VkImageUsageFlags getImageUsageFlags () const
 
virtual uint getLayerCount () const override
 
virtual uint getMipLevels () const override
 
virtual const ImageDatagetHandle () const override
 
virtual ImageDatagetHandle () override
 
- Public Member Functions inherited from Texture
 Texture (Core &core)
 
virtual ~Texture ()
 
virtual VkImageLayout getTargetLayout () const
 
VkFormat getFormat () const
 
const SurfaceDescriptorgetDescriptor () const
 
RenderServicegetRenderService ()
 
const RenderServicegetRenderService () const
 
- Public Member Functions inherited from Resource
 Resource ()
 
- Public Member Functions inherited from Object
 Object ()
 
virtual ~Object ()
 
 Object (Object &)=delete
 
Objectoperator= (const Object &)=delete
 
 Object (Object &&)=delete
 
Objectoperator= (Object &&)=delete
 

Public Attributes

std::string mImagePath
 Property: 'ImagePath' Path to the image on disk to load. More...
 
bool mSampleShading = false
 Property: 'SampleShading' Reduces texture aliasing when enabled, at higher computational cost. More...
 
bool mGenerateLODs
 
- Public Attributes inherited from RenderTextureCube
int mWidth = 0
 Property: 'Width' width of a cube face texture in texels. More...
 
int mHeight = 0
 Property: 'Height' of a cube face texture in texels. More...
 
EColorSpace mColorSpace = EColorSpace::Linear
 Property: 'ColorSpace' texture color space. More...
 
EFormat mColorFormat = EFormat::RGBA8
 Property: 'ColorFormat' color texture format. More...
 
RGBAColorFloat mClearColor = { 0.0f, 0.0f, 0.0f, 0.0f }
 Property: 'ClearColor' color selection used for clearing the texture. More...
 
- Public Attributes inherited from TextureCube
const EUsage mUsage = EUsage::Static
 Texture usage (cube maps are currently always static) More...
 
- Public Attributes inherited from Texture
nap::Signal textureDestroyed
 Signal that is triggered before texture is destroyed. More...
 
- Public Attributes inherited from Object
std::string mID
 Property: 'mID' unique name of the object. Used as an identifier by the system. More...
 

Additional Inherited Members

- Public Types inherited from RenderTextureCube
enum  EFormat {
  RGBA8, BGRA8, R8, RGBA16,
  R16, RGBA32, R32
}
 
- Public Types inherited from Texture
enum  EUsage { Static, DynamicRead, DynamicWrite }
 
- Static Public Member Functions inherited from Object
static bool isIDProperty (rtti::Instance &object, const rtti::Property &property)
 
- Static Public Attributes inherited from TextureCube
static constexpr const uint layerCount = 6
 
- Protected Member Functions inherited from Texture
virtual void clear (VkCommandBuffer commandBuffer)
 
void requestClear ()
 
- Protected Attributes inherited from RenderTextureCube
bool mGenerateLODs = false
 
- Protected Attributes inherited from TextureCube
ImageData mImageData = { TextureCube::layerCount }
 Cube Texture vulkan image buffers. More...
 
uint32 mMipLevels = 1
 Total number of generated mip-maps. More...
 
- Protected Attributes inherited from Texture
RenderServicemRenderService
 Reference to the render service. More...
 
SurfaceDescriptor mDescriptor
 Texture description. More...
 
VkFormat mFormat = VK_FORMAT_UNDEFINED
 Vulkan texture format. More...
 
VkClearColorValue mClearColor = { 0.0f, 0.0f, 0.0f, 0.0f }
 Color used for clearing the texture. More...
 

Description

Loads equirectangular image from disk, uploads it to the GPU, and schedules a rendering operation to generate a cube map from it in the nap::RenderAdvancedService. If GenerateLODs is enabled, GPU memory for mip-maps (LODs) are allocated and will be updated using blit operations after the cube face render passes.

This object must be pre-rendered at least once in a headless render pass in the first frame. The RenderAdvanced service queues a headless RenderService::RenderCommand for each nap::CubeMapFromFile in the scene after resource initialization, and will be handled when headless render commands are recorded. The code below only begins a headless recording operation only when headless commands are queued in the render service.

{
// Handles `nap::CubeMapFromFile` pre-render operations in the first frame
}
Inheritance diagram for CubeMapFromFile:
[legend]
Collaboration diagram for CubeMapFromFile:
[legend]

Constructor & Destructor Documentation

◆ ~CubeMapFromFile()

virtual ~CubeMapFromFile ( )
virtual

◆ CubeMapFromFile()

CubeMapFromFile ( Core core)
Parameters
corethe core instance

Member Function Documentation

◆ getSourceTexture()

Texture2D& getSourceTexture ( ) const
Returns
the source texture

◆ init()

virtual bool init ( utility::ErrorState errorState)
overridevirtual

Loads the image from disk and schedules the upload to the GPU on success.

Parameters
errorStatecontains the error when initialization fails
Returns
true when successful, otherwise false.

Reimplemented from RenderTextureCube.

◆ onDestroy()

virtual void onDestroy ( )
overridevirtual

Deregisters this CubeMapFromFile

Reimplemented from Texture.

Member Data Documentation

◆ mGenerateLODs

bool mGenerateLODs

◆ mImagePath

std::string mImagePath

Property: 'ImagePath' Path to the image on disk to load.

◆ mSampleShading

bool mSampleShading = false

Property: 'SampleShading' Reduces texture aliasing when enabled, at higher computational cost.

nap::RenderService::isHeadlessCommandQueued
bool isHeadlessCommandQueued() const
Definition: renderservice.h:718
nap::RenderService::beginHeadlessRecording
bool beginHeadlessRecording()
nap::RenderService::endHeadlessRecording
void endHeadlessRecording()
nap::Texture::mRenderService
RenderService & mRenderService
Reference to the render service.
Definition: texture.h:115