#include <OgreVulkanTextureGpu.h>

Inheritance diagram for Ogre::VulkanTextureGpu:

Public Member Functions
	VulkanTextureGpu (TextureManager textureManager, const String &name, ResourceHandle handle, const String &group, bool isManual, ManualResourceLoader loader)

virtual	~VulkanTextureGpu ()

void	_autogenerateMipmaps (bool bUseBarrierSolver=false)

VkImageView	_createView (uint8 mipLevel, uint8 numMipmaps, uint16 arraySlice, uint32 numSlices=0u, VkImage imageOverride=0) const

virtual void	copyTo (TextureGpu *dst, const PixelBox &dstBox, uint8 dstMipLevel, const PixelBox &srcBox, uint8 srcMipLevel, bool keepResolvedTexSynced=true, ResourceAccess::ResourceAccess issueBarriers=ResourceAccess::ReadWrite)

VkImageView	createView (void) const

void	destroyView (VkImageView imageView)

VkImageLayout	getCurrentLayout (void) const

VkImageView	getDefaultDisplaySrv (void) const

VkImage	getDisplayTextureName (void) const

VkImage	getFinalTextureName (void) const

VkImageMemoryBarrier	getImageMemoryBarrier (void) const
	Returns a fresh VkImageMemoryBarrier filled with common data. More...

VkImageViewType	getInternalVulkanTextureViewType (void) const

VkImage	getMsaaTextureName (void) const

uint32	getNumLayers () const

VkImageType	getVulkanTextureType (void) const

bool	hasMsaaExplicitResolves () const

bool	isMultisample () const

virtual bool	isRenderWindowSpecific () const

bool	isUav () const

Public Member Functions inherited from Ogre::Texture
	Texture (ResourceManager creator, const String &name, ResourceHandle handle, const String &group, bool isManual=false, ManualResourceLoader loader=0)

virtual	~Texture ()

void	_loadImages (const ConstImagePtrList &images)
	Internal method to load the texture from a set of images. More...

void	convertToImage (Image &destImage, bool includeMipMaps=false)
	Populate an Image with the contents of this texture. More...

virtual void	copyToTexture (TexturePtr &target)
	Copies (and maybe scales to fit) the contents of this texture to another texture. More...

void	createInternalResources (void)
	Creates the internal texture resources for this texture. More...

virtual void	createShaderAccessPoint (uint bindPoint, TextureAccess access=TA_READ_WRITE, int mipmapLevel=0, int textureArrayIndex=0, PixelFormat format=PF_UNKNOWN)
	Enable read and/or write privileges to the texture from shaders. More...

virtual const HardwarePixelBufferSharedPtr &	getBuffer (size_t face=0, size_t mipmap=0)
	Return hardware pixel buffer for a surface. More...

virtual void	getCustomAttribute (const String &name, void *pData)
	Retrieve a platform or API-specific piece of information from this texture. More...

uint	getCustomAttribute (const String &name)
	simplified API for bindings More...

uint32	getDepth (void) const
	Returns the depth of the texture (only applicable for 3D textures). More...

ushort	getDesiredFloatBitDepth (void) const
	gets desired bit depth for float pixel format textures. More...

PixelFormat	getDesiredFormat (void) const
	Returns the desired pixel format for the texture surface. More...

ushort	getDesiredIntegerBitDepth (void) const
	gets desired bit depth for integer pixel format textures. More...

PixelFormat	getFormat () const
	Returns the pixel format for the texture surface. More...

uint	getFSAA () const
	Get the level of multisample AA to be used if this texture is a rendertarget. More...

const String &	getFSAAHint () const
	Get the multisample AA hint if this texture is a rendertarget. More...

float	getGamma (void) const
	Returns the gamma adjustment factor applied to this texture on loading. More...

uint32	getHeight (void) const
	Returns the height of the texture. More...

bool	getMipmapsHardwareGenerated (void) const
	Are mipmaps hardware generated? More...

uint32	getNumFaces () const
	Return the number of faces this texture has. More...

uint32	getNumMipmaps (void) const
	Gets the number of mipmaps to be used for this texture. More...

uint32	getSrcDepth (void) const
	Returns the original depth of the input texture (only applicable for 3D textures). More...

PixelFormat	getSrcFormat (void) const
	Returns the pixel format of the original input texture (may differ due to hardware requirements and pixel format conversion). More...

uint32	getSrcHeight (void) const
	Returns the height of the original input texture (may differ due to hardware requirements). More...

uint32	getSrcWidth (void) const
	Returns the width of the original input texture (may differ due to hardware requirements). More...

TextureType	getTextureType (void) const
	Gets the type of texture. More...

int	getUsage () const
	Returns the TextureUsage identifier for this Texture. More...

uint32	getWidth (void) const
	Returns the width of the texture. More...

bool	hasAlpha (void) const
	Returns true if the texture has an alpha layer. More...

bool	isHardwareGammaEnabled () const
	Gets whether this texture will be set up so that on sampling it, hardware gamma correction is applied. More...

void	loadImage (const Image &img)
	Loads the data from an image. More...

void	loadRawData (DataStreamPtr &stream, ushort uWidth, ushort uHeight, PixelFormat eFormat)
	Loads the data from a raw stream. More...

void	setDepth (uint32 d)
	Set the depth of the texture (only applicable for 3D textures); can only do this before load();. More...

void	setDesiredBitDepths (ushort integerBits, ushort floatBits)
	Sets desired bit depth for integer and float pixel format. More...

void	setDesiredFloatBitDepth (ushort bits)
	Sets desired bit depth for float pixel format textures. More...

void	setDesiredIntegerBitDepth (ushort bits)
	Sets desired bit depth for integer pixel format textures. More...

void	setFormat (PixelFormat pf)
	Sets the desired pixel format for the texture surface; can only be set before load(). More...

void	setFSAA (uint fsaa, const String &fsaaHint)
	Set the level of multisample AA to be used if this texture is a rendertarget. More...

void	setGamma (float g)
	Sets the gamma adjustment factor applied to this texture on loading the data. More...

void	setHardwareGammaEnabled (bool enabled)
	Sets whether this texture will be set up so that on sampling it, hardware gamma correction is applied. More...

void	setHeight (uint32 h)
	Set the height of the texture; can only do this before load();. More...

void	setLayerNames (const std::vector< String > &names)
	Set image names to be loaded as layers (3d & texture array) or cubemap faces. More...

void	setNumMipmaps (uint32 num)
	Sets the number of mipmaps to be used for this texture. More...

void	setTextureType (TextureType ttype)
	Sets the type of texture; can only be changed before load() More...

void	setTreatLuminanceAsAlpha (bool asAlpha)

void	setUsage (int u)
	Sets the TextureUsage identifier for this Texture; only useful before load() More...

void	setWidth (uint32 w)
	Set the width of the texture; can only do this before load();. More...

Public Member Functions inherited from Ogre::Resource
	Resource (ResourceManager creator, const String &name, ResourceHandle handle, const String &group, bool isManual=false, ManualResourceLoader loader=0)
	Standard constructor. More...

virtual	~Resource ()
	Virtual destructor. More...

virtual void	_dirtyState ()
	Manually mark the state of this resource as having been changed. More...

void	_fireLoadingComplete (bool unused=false)
	Firing of loading complete event. More...

void	_firePreparingComplete (bool unused=false)
	Firing of preparing complete event. More...

void	_fireUnloadingComplete (void)
	Firing of unloading complete event. More...

void	_notifyOrigin (const String &origin)
	Notify this resource of it's origin. More...

virtual void	addListener (Listener *lis)
	Register a listener on this resource. More...

virtual void	changeGroupOwnership (const String &newGroup)
	Change the resource group ownership of a Resource. More...

virtual void	escalateLoading ()
	Escalates the loading of a background loaded resource. More...

ResourceManager *	getCreator (void)
	Gets the manager which created this resource. More...

const String &	getGroup (void) const
	Gets the group which this resource is a member of. More...

ResourceHandle	getHandle (void) const

LoadingState	getLoadingState () const
	Returns the current loading state. More...

const String &	getName (void) const
	Gets resource name. More...

const String &	getOrigin (void) const
	Get the origin of this resource, e.g. More...

size_t	getSize (void) const
	Retrieves info about the size of the resource. More...

virtual size_t	getStateCount () const
	Returns the number of times this resource has changed state, which generally means the number of times it has been loaded. More...

bool	isBackgroundLoaded (void) const
	Returns whether this Resource has been earmarked for background loading. More...

bool	isLoaded (void) const
	Returns true if the Resource has been loaded, false otherwise. More...

bool	isLoading () const
	Returns whether the resource is currently in the process of background loading. More...

bool	isManuallyLoaded (void) const
	Is this resource manually loaded? More...

bool	isPrepared (void) const
	Returns true if the Resource has been prepared, false otherwise. More...

bool	isReloadable (void) const
	Returns true if the Resource is reloadable, false otherwise. More...

virtual void	load (bool backgroundThread=false)
	Loads the resource, if it is not already. More...

virtual void	prepare (bool backgroundThread=false)
	Prepares the resource for load, if it is not already. More...

virtual void	reload (LoadingFlags flags=LF_DEFAULT)
	Reloads the resource, if it is already loaded. More...

virtual void	removeListener (Listener *lis)
	Remove a listener on this resource. More...

void	setBackgroundLoaded (bool bl)
	Tells the resource whether it is background loaded or not. More...

virtual void	touch (void)
	'Touches' the resource to indicate it has been used. More...

virtual void	unload (void)
	Unloads the resource; this is not permanent, the resource can be reloaded later if required. More...

Public Member Functions inherited from Ogre::StringInterface
	StringInterface ()

virtual	~StringInterface ()
	Virtual destructor, see Effective C++. More...

void	copyParametersTo (StringInterface *dest) const
	Method for copying this object's parameters to another object. More...

ParamDictionary *	getParamDictionary (void)
	Retrieves the parameter dictionary for this class. More...

const ParamDictionary *	getParamDictionary (void) const

String	getParameter (const String &name) const
	Generic parameter retrieval method. More...

const ParameterList &	getParameters (void) const
	Retrieves a list of parameters valid for this object. More...

bool	setParameter (const String &name, const String &value)
	Generic parameter setting method. More...

void	setParameterList (const NameValuePairList &paramList)
	Generic multiple parameter setting method. More...

Public Attributes
VkImageLayout	mCurrLayout
	The current layout we're in. Including any internal stuff. More...

VkImageLayout	mNextLayout
	The layout we're expected to be when rendering or doing compute, rather than when doing internal stuff (e.g. More...

Additional Inherited Members
Public Types inherited from Ogre::Resource
enum	LoadingFlags { LF_DEFAULT = 0, LF_INCLUDE_NON_RELOADABLE = 1, LF_ONLY_UNREFERENCED = 2, LF_ONLY_UNREFERENCED_INCLUDE_NON_RELOADABLE = 3, LF_PRESERVE_STATE = 4 }
	Enum that allow to choose subset of unloaded/reloaded resources and to adjust reloading behavior. More...

enum	LoadingState { LOADSTATE_UNLOADED, LOADSTATE_LOADING, LOADSTATE_LOADED, LOADSTATE_UNLOADING, LOADSTATE_PREPARED, LOADSTATE_PREPARING }
	Enum identifying the loading state of the resource. More...

Static Public Member Functions inherited from Ogre::StringInterface
static void	cleanupDictionary ()
	Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g. More...

Constructor & Destructor Documentation

◆ VulkanTextureGpu()

Ogre::VulkanTextureGpu::VulkanTextureGpu	(	TextureManager *	textureManager,
		const String &	name,
		ResourceHandle	handle,
		const String &	group,
		bool	isManual,
		ManualResourceLoader *	loader
	)

◆ ~VulkanTextureGpu()

virtual Ogre::VulkanTextureGpu::~VulkanTextureGpu ( )

virtual

Member Function Documentation

◆ getNumLayers()

uint32 Ogre::VulkanTextureGpu::getNumLayers ( ) const

inline

References Ogre::TEX_TYPE_2D_ARRAY.

◆ hasMsaaExplicitResolves()

bool Ogre::VulkanTextureGpu::hasMsaaExplicitResolves ( ) const

inline

◆ isUav()

bool Ogre::VulkanTextureGpu::isUav ( ) const

inline

◆ isMultisample()

bool Ogre::VulkanTextureGpu::isMultisample ( ) const

inline

◆ isRenderWindowSpecific()

virtual bool Ogre::VulkanTextureGpu::isRenderWindowSpecific ( ) const

inlinevirtual

Reimplemented in Ogre::VulkanTextureGpuWindow.

◆ getCurrentLayout()

VkImageLayout Ogre::VulkanTextureGpu::getCurrentLayout ( void ) const

inline

References Ogre::ResourceAccess::ReadWrite.

◆ copyTo()

virtual void Ogre::VulkanTextureGpu::copyTo	(	TextureGpu *	dst,
		const PixelBox &	dstBox,
		uint8	dstMipLevel,
		const PixelBox &	srcBox,
		uint8	srcMipLevel,
		bool	keepResolvedTexSynced = `true`,
		ResourceAccess::ResourceAccess	issueBarriers = `ResourceAccess::ReadWrite`
	)

virtual

◆ _autogenerateMipmaps()

void Ogre::VulkanTextureGpu::_autogenerateMipmaps ( bool bUseBarrierSolver = false )

◆ getVulkanTextureType()

VkImageType Ogre::VulkanTextureGpu::getVulkanTextureType ( void ) const

◆ getInternalVulkanTextureViewType()

VkImageViewType Ogre::VulkanTextureGpu::getInternalVulkanTextureViewType ( void ) const

◆ _createView()

VkImageView Ogre::VulkanTextureGpu::_createView	(	uint8	mipLevel,
		uint8	numMipmaps,
		uint16	arraySlice,
		uint32	numSlices = `0u`,
		VkImage	imageOverride = `0`
	)		const

◆ createView()

VkImageView Ogre::VulkanTextureGpu::createView ( void ) const

◆ getDefaultDisplaySrv()

VkImageView Ogre::VulkanTextureGpu::getDefaultDisplaySrv ( void ) const

inline

◆ destroyView()

void Ogre::VulkanTextureGpu::destroyView ( VkImageView imageView )

◆ getImageMemoryBarrier()

VkImageMemoryBarrier Ogre::VulkanTextureGpu::getImageMemoryBarrier ( void ) const

Returns a fresh VkImageMemoryBarrier filled with common data.

srcAccessMask, dstAccessMask, oldLayout and newLayout must be filled by caller

◆ getDisplayTextureName()

VkImage Ogre::VulkanTextureGpu::getDisplayTextureName ( void ) const

inline

◆ getFinalTextureName()

VkImage Ogre::VulkanTextureGpu::getFinalTextureName ( void ) const

inline

◆ getMsaaTextureName()

VkImage Ogre::VulkanTextureGpu::getMsaaTextureName ( void ) const

inline

Member Data Documentation

◆ mCurrLayout

VkImageLayout Ogre::VulkanTextureGpu::mCurrLayout

The current layout we're in. Including any internal stuff.

◆ mNextLayout

VkImageLayout Ogre::VulkanTextureGpu::mNextLayout

The layout we're expected to be when rendering or doing compute, rather than when doing internal stuff (e.g.

this variable won't contain VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, because that origins from C++ operations and are not expected by the compositor)

When mCurrLayout != mNextLayout, it means that there is already a layout transition that will be happening to achieve mCurrLayout = mNextLayout

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

OgreVulkanTextureGpu.h

Public Member Functions

Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ VulkanTextureGpu()

◆ ~VulkanTextureGpu()

Member Function Documentation

◆ getNumLayers()

◆ hasMsaaExplicitResolves()

◆ isUav()

◆ isMultisample()

◆ isRenderWindowSpecific()

◆ getCurrentLayout()

◆ copyTo()

◆ _autogenerateMipmaps()

◆ getVulkanTextureType()

◆ getInternalVulkanTextureViewType()

◆ _createView()

◆ createView()

◆ getDefaultDisplaySrv()

◆ destroyView()

◆ getImageMemoryBarrier()

◆ getDisplayTextureName()

◆ getFinalTextureName()

◆ getMsaaTextureName()

Member Data Documentation

◆ mCurrLayout

◆ mNextLayout