Castor3D 0.12.0
Multiplatform 3D engine
Fonctions membres publiques | Liste de tous les membres
Référence de la classe castor3d::ImageBackground

#include <Image.hpp>

Graphe d'héritage de castor3d::ImageBackground:
Inheritance graph
[légende]
Graphe de collaboration de castor3d::ImageBackground:
Collaboration graph
[légende]

Fonctions membres publiques

C3D_API ImageBackground (Engine &engine, Scene &scene, castor::String const &name=castor::String{})
 Constructeur. Plus de détails...
 
C3D_API bool loadImage (castor::Path const &folder, castor::Path const &relative)
 
C3D_API void accept (BackgroundVisitor &visitor) override
 Fonction d'acceptation de visiteur. Plus de détails...
 
- Fonctions membres publiques hérités de castor3d::SceneBackground
C3D_API SceneBackground (Engine &engine, Scene &scene, castor::String const &name, BackgroundType type)
 Constructeur. Plus de détails...
 
virtual C3D_API ~SceneBackground ()
 Destructeur. Plus de détails...
 
C3D_API bool initialise (RenderDevice const &device)
 Fonction d'initialisation. Plus de détails...
 
C3D_API void cleanup (RenderDevice const &device)
 Fonction de nettoyage. Plus de détails...
 
C3D_API void update (CpuUpdater &updater) const
 Met à jour le fond, niveau CPU. Plus de détails...
 
C3D_API void update (GpuUpdater &updater) const
 Met à jour le fond, niveau GPU. Plus de détails...
 
C3D_API void notifyChanged ()
 Notifie un changement affectant le GPU pour le fond. Plus de détails...
 
virtual C3D_API void accept (BackgroundVisitor &visitor)=0
 Fonction d'acceptation de visiteur. Plus de détails...
 
Scene const & getScene () const
 
ScenegetScene ()
 
BackgroundType getType () const
 
Texture const & getTextureId () const
 
TextureLayout const & getTexture () const
 
TextureLayoutgetTexture ()
 
ashes::Image const & getImage () const
 
ashes::ImageView const & getView () const
 
bool isHdr () const
 
bool isSRGB () const
 
bool hasIbl () const
 
bool isInitialised () const
 
IblTextures const & getIbl () const
 
Sampler const & getSampler () const
 

Membres hérités additionnels

- Types publics hérités de castor3d::SceneBackground
enum  DescriptorIdx : uint32_t {
  MtxUboIdx = 0u , MdlMtxUboIdx = 1u , HdrCfgUboIdx = 2u , SceneUboIdx = 3u ,
  SkyBoxImgIdx = 4u
}
 
- Attributs publics hérités de castor3d::SceneBackground
OnBackgroundChanged onChanged
 
- Attributs protégés hérités de castor3d::SceneBackground
Scenem_scene
 
BackgroundType m_type
 
std::atomic_bool m_initialised { false }
 
bool m_hdr { true }
 
bool m_srgb { false }
 
Texture m_textureId
 
TextureLayoutSPtr m_texture
 
SamplerResPtr m_sampler
 
std::unique_ptr< IblTexturesm_ibl
 

Documentation des constructeurs et destructeur

◆ ImageBackground()

C3D_API castor3d::ImageBackground::ImageBackground ( Engine engine,
Scene scene,
castor::String const &  name = castor::String{} 
)
explicit

Constructeur.

Paramètres
[in]engineLe moteur.
[in]sceneLa scène parente.
nameLe nom du fond.

Documentation des fonctions membres

◆ accept()

C3D_API void castor3d::ImageBackground::accept ( BackgroundVisitor visitor)
overridevirtual

Fonction d'acceptation de visiteur.

Paramètres
visitorLe visiteur.

Implémente castor3d::SceneBackground.

◆ loadImage()

C3D_API bool castor3d::ImageBackground::loadImage ( castor::Path const &  folder,
castor::Path const &  relative 
)
Renvoie
Définit l'image de la texture.
Paramètres
[in]folderLe dossier de l'image.
[in]relativeLe chemin d'accès à l'image, relatif à folder.

La documentation de cette classe a été générée à partir du fichier suivant :