#include <OgreMetalTextureGpu.h>

Inheritance diagram for Ogre::MetalTextureGpu:

Public Member Functions
	MetalTextureGpu (GpuPageOutStrategy::GpuPageOutStrategy pageOutStrategy, VaoManager vaoManager, IdString name, uint32 textureFlags, TextureTypes::TextureTypes initialType, TextureGpuManager textureManager)

virtual	~MetalTextureGpu ()

void	_addPendingResidencyChanges (uint32 value)

virtual void	_autogenerateMipmaps (void)
	Tells the API to let the HW autogenerate mipmaps. More...

uint8 *	_getSysRamCopy (uint8 mipLevel)

TextureBox	_getSysRamCopyAsBox (uint8 mipLevel)

size_t	_getSysRamCopyBytesPerImage (uint8 mipLevel)
	Note: Returns non-zero even if there is no system ram copy. More...

size_t	_getSysRamCopyBytesPerRow (uint8 mipLevel)
	Note: Returns non-zero even if there is no system ram copy. More...

virtual bool	_isDataReadyImpl (void) const
	For internal use. More...

bool	_isManualTextureFlagPresent (void) const

void	_notifySysRamDownloadIsReady (uint8 *sysRamPtr, bool resyncOnly)
	Do not call directly. More...

virtual void	_notifyTextureSlotChanged (const TexturePool *newPool, uint16 slice)

void	_resetTextureManager (void)

void	_resolveTo (TextureGpu *resolveTexture)
	Immediately resolves this texture to the resolveTexture argument. More...

virtual void	_setDepthBufferDefaults (uint16 depthBufferPoolId, bool preferDepthTexture, PixelFormatGpu desiredDepthBufferFormat)
	These 3 values are used as defaults for the compositor to use, but they may be explicitly overriden by a RenderPassDescriptor. More...

void	_setNextResidencyStatus (GpuResidency::GpuResidency nextResidency)

void	_setSampleDescription (SampleDescription desc, SampleDescription validatedSampleDesc)
	For internal use. More...

void	_setSourceType (uint8 type)

virtual void	_setToDisplayDummyTexture (void)

void	_syncGpuResidentToSystemRam (void)
	Forces downloading data from GPU to CPU, usually because the data on GPU changed and we're in strategy AlwaysKeepSystemRamCopy. More...

void	_transitionTo (GpuResidency::GpuResidency newResidency, uint8 *sysRamCopy, bool autoDeleteSysRamCopy=true)
	This function may be called manually (if user is manually managing a texture) or automatically (e.g. More...

void	addListener (TextureGpuListener *listener)

bool	allowsAutoMipmaps (void) const

void	copyContentsToMemory (TextureBox src, TextureBox dst, PixelFormatGpu dstFormat, bool automaticResolve=true)
	Writes the current contents of the render target to the memory. More...

void	copyParametersFrom (TextureGpu *src)

virtual void	copyTo (TextureGpu *dst, const TextureBox &dstBox, uint8 dstMipLevel, const TextureBox &srcBox, uint8 srcMipLevel, bool keepResolvedTexSynced=true)

virtual void	getCustomAttribute (IdString name, void *pData)

uint32	getDepth (void) const
	For TypeCube & TypeCubeArray, this value returns 1. More...

virtual uint16	getDepthBufferPoolId (void) const

uint32	getDepthOrSlices (void) const

virtual PixelFormatGpu	getDesiredDepthBufferFormat (void) const

id< MTLTexture >	getDisplayTextureName (void) const

TextureBox	getEmptyBox (uint8 mipLevel)

id< MTLTexture >	getFinalTextureName (void) const

GpuPageOutStrategy::GpuPageOutStrategy	getGpuPageOutStrategy (void) const

uint32	getHeight (void) const

uint32	getInternalSliceStart (void) const

TextureTypes::TextureTypes	getInternalTextureType (void) const

const vector< TextureGpuListener * >::type &	getListeners (void) const

id< MTLTexture >	getMsaaFramebufferName (void) const

IdString	getName (void) const

virtual String	getNameStr (void) const
	Note: This returns the alias name of the texture. More...

GpuResidency::GpuResidency	getNextResidencyStatus (void) const
	When getResidencyStatus() != getNextResidencyStatus(), residency changes happen in the main thread, while some preparation may be happening in the background. More...

uint8	getNumMipmaps (void) const

uint32	getNumSlices (void) const
	For TypeCube this value returns 6. More...

uint32	getPendingResidencyChanges (void) const
	Returns the number of pending residency changes. More...

PixelFormatGpu	getPixelFormat (void) const

virtual bool	getPreferDepthTexture (void) const

virtual String	getRealResourceNameStr (void) const
	Returns the real name (e.g. disk in file) of the resource. More...

SampleDescription	getRequestedSampleDescription (void) const
	Returns original requested sample description, i.e. the raw input to setSampleDescription. More...

GpuResidency::GpuResidency	getResidencyStatus (void) const

virtual String	getResourceGroupStr (void) const

SampleDescription	getSampleDescription (void) const
	Returns effective sample description supported by the API. More...

String	getSettingsDesc (void) const

size_t	getSizeBytes (void) const
	Returns total size in bytes used in GPU by this texture (not by its pool) including mipmaps. More...

uint8	getSourceType (void) const

virtual void	getSubsampleLocations (vector< Vector2 >::type locations)
	Get the MSAA subsample locations. More...

TextureGpuManager *	getTextureManager (void) const

const TexturePool *	getTexturePool (void) const

uint32	getTexturePoolId (void) const

TextureTypes::TextureTypes	getTextureType (void) const

id< MTLTexture >	getView (PixelFormatGpu pixelFormat, uint8 mipLevel, uint8 numMipmaps, uint16 arraySlice, bool cubemapsAs2DArrays, bool forUav)

id< MTLTexture >	getView (DescriptorSetTexture2::TextureSlot texSlot)

id< MTLTexture >	getView (DescriptorSetUav::TextureSlot uavSlot)

uint32	getWidth (void) const

bool	hasAutomaticBatching (void) const

bool	hasAutoMipmapAuto (void) const

bool	hasEquivalentParameters (TextureGpu *other) const

bool	hasMsaaExplicitResolves (void) const

bool	isDataReady (void)
	True if this texture is fully ready to be used for displaying. More...

bool	isManualTexture (void) const

bool	isMetadataReady (void) const
	It is threadsafe to call this function from main thread. More...

virtual bool	isMsaaPatternSupported (MsaaPatterns::MsaaPatterns pattern)

bool	isMultisample (void) const

virtual bool	isOpenGLRenderWindow (void) const
	OpenGL RenderWindows are a bit specific: More...

bool	isPoolOwner (void) const

bool	isReinterpretable (void) const

bool	isRenderToTexture (void) const

bool	isRenderWindowSpecific (void) const

bool	isTexture (void) const

bool	isUav (void) const

void	notifyAllListenersTextureChanged (uint32 reason, void *extraData=0)

virtual void	notifyDataIsReady (void)
	Notifies it is safe to use the real data. Everything has been uploaded. More...

void	operator delete (void *ptr)

void	operator delete (void ptr, void )

void	operator delete (void ptr, const char , int, const char *)

void	operator delete[] (void *ptr)

void	operator delete[] (void ptr, const char , int, const char *)

void *	operator new (size_t sz, const char file, int line, const char func)
	operator new, with debug line info More...

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *ptr)
	placement operator new More...

void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info More...

void *	operator new[] (size_t sz)

bool	prefersLoadingFromFileAsSRGB (void) const

void	removeListener (TextureGpuListener *listener)

bool	requiresTextureFlipping (void) const

void	scheduleTransitionTo (GpuResidency::GpuResidency nextResidency, Image2 *image=0, bool autoDeleteImage=true)
	Same as unsafeScheduleTransitionTo, but first checks if we're already in the residency state we want to go to, or if it has already been scheduled; thus it can be called multiple times. More...

void	setNumMipmaps (uint8 numMipmaps)

void	setPixelFormat (PixelFormatGpu pixelFormat)
	Sets the pixel format. More...

void	setResolution (uint32 width, uint32 height, uint32 depthOrSlices=1u)

void	setSampleDescription (SampleDescription desc)

void	setTexturePoolId (uint32 poolId)
	2D Texture with automatic batching will be merged with other textures into the same pool as one big 2D Array texture behind the scenes. More...

virtual void	setTextureType (TextureTypes::TextureTypes textureType)

virtual bool	supportsAsDepthBufferFor (TextureGpu *colourTarget) const

virtual void	swapBuffers (void)
	Only valid for TextureGpu classes. More...

void	unsafeScheduleTransitionTo (GpuResidency::GpuResidency nextResidency, Image2 *image=0, bool autoDeleteImage=true)
	Schedules an async transition in residency. More...

void	waitForData (void)
	Blocks main thread until data is ready. More...

void	waitForMetadata (void)
	Blocks main thread until metadata is ready. More...

void	writeContentsToFile (const String &filename, uint8 minMip, uint8 maxMip, bool automaticResolve=true)
	Writes the current contents of the render target to the named file. More...

Static Public Attributes
static const IdString	msFinalTextureBuffer

static const IdString	msMsaaTextureBuffer

Constructor & Destructor Documentation

◆ MetalTextureGpu()

Ogre::MetalTextureGpu::MetalTextureGpu	(	GpuPageOutStrategy::GpuPageOutStrategy	pageOutStrategy,
		VaoManager *	vaoManager,
		IdString	name,
		uint32	textureFlags,
		TextureTypes::TextureTypes	initialType,
		TextureGpuManager *	textureManager
	)

◆ ~MetalTextureGpu()

virtual Ogre::MetalTextureGpu::~MetalTextureGpu ( )

virtual

Member Function Documentation

◆ _addPendingResidencyChanges()

void Ogre::GpuResource::_addPendingResidencyChanges ( uint32 value )

inherited

◆ _autogenerateMipmaps()

virtual void Ogre::MetalTextureGpu::_autogenerateMipmaps ( void )

virtual

Tells the API to let the HW autogenerate mipmaps.

Assumes the allowsAutoMipmaps() == true and isRenderToTexture() == true

Implements Ogre::TextureGpu.

◆ _getSysRamCopy()

uint8* Ogre::TextureGpu::_getSysRamCopy ( uint8 mipLevel )

inherited

◆ _getSysRamCopyAsBox()

TextureBox Ogre::TextureGpu::_getSysRamCopyAsBox ( uint8 mipLevel )

inherited

◆ _getSysRamCopyBytesPerImage()

size_t Ogre::TextureGpu::_getSysRamCopyBytesPerImage ( uint8 mipLevel )

inherited

Note: Returns non-zero even if there is no system ram copy.

◆ _getSysRamCopyBytesPerRow()

size_t Ogre::TextureGpu::_getSysRamCopyBytesPerRow ( uint8 mipLevel )

inherited

Note: Returns non-zero even if there is no system ram copy.

◆ _isDataReadyImpl()

virtual bool Ogre::MetalTextureGpu::_isDataReadyImpl ( void ) const

virtual

For internal use.

Do not call directly.

This function is the same isDataReady except it ignores pending residency changes, which is important when TextureGpuManager needs to know this information but the TextureGpu is transitioning (thus mPendingResidencyChanges is in an inconsistent state)

Implements Ogre::TextureGpu.

Reimplemented in Ogre::MetalTextureGpuWindow.

◆ _isManualTextureFlagPresent()

bool Ogre::TextureGpu::_isManualTextureFlagPresent ( void ) const

inherited

◆ _notifySysRamDownloadIsReady()

void Ogre::TextureGpu::_notifySysRamDownloadIsReady	(	uint8 *	sysRamPtr,
		bool	resyncOnly
	)

inherited

Do not call directly.

Will change mResidencyStatus from GpuResidency::Resident to GpuResidency::OnSystemRam

◆ _notifyTextureSlotChanged()

virtual void Ogre::MetalTextureGpu::_notifyTextureSlotChanged	(	const TexturePool *	newPool,
		uint16	slice
	)

virtual

Reimplemented from Ogre::TextureGpu.

Reimplemented in Ogre::MetalTextureGpuWindow.

◆ _resetTextureManager()

void Ogre::TextureGpu::_resetTextureManager ( void )

inherited

◆ _resolveTo()

void Ogre::TextureGpu::_resolveTo ( TextureGpu * resolveTexture )

inherited

Immediately resolves this texture to the resolveTexture argument.

Source must be MSAA texture, destination must be non-MSAA.

Remarks: This function may be slow on some APIs and should only be used when required, for example, to capture the screen from an explicit MSAA target and save it to disk only on user demand. If you need to call this often (like once per frame or more), then consider setting a Compositor with CompositorNode::mLocalRtvs::resolveTextureName set so that the compositor automatically resolves the texture every frame as efficiently as possible.

◆ _setDepthBufferDefaults()

virtual void Ogre::TextureGpu::_setDepthBufferDefaults	(	uint16	depthBufferPoolId,
		bool	preferDepthTexture,
		PixelFormatGpu	desiredDepthBufferFormat
	)

virtualinherited

These 3 values are used as defaults for the compositor to use, but they may be explicitly overriden by a RenderPassDescriptor.

Particularly required when passing the textures between nodes as input and output (since only the TextureGpu pointer is passed, and thus this information is lost)

Remarks: Changing these settings won't take immediate effect because they're only used when creating the compositor.

Parameters

depthBufferPoolId	Sets the pool ID this RenderTarget should query from. Default value is POOL_DEFAULT. Set to POOL_NO_DEPTH to avoid using a DepthBuffer (or manually controlling it)
preferDepthTexture	Whether this RT should be attached to a depth texture, or a regular depth buffer. On older GPUs, preferring depth textures may result in certain depth precisions to not be available (or use integer precision instead of floating point, etc). True to use depth textures. False otherwise (default).
desiredDepthBufferFormat	Ogre will try to honour this request, but if it's not supported, you may get lower precision. All formats will try to fallback to PF_D24_UNORM_S8_UINT if not supported. Must be one of the following: PFG_D24_UNORM_S8_UINT PFG_D16_UNORM PFG_D32_FLOAT PFG_D32_FLOAT_X24_S8_UINT

Reimplemented in Ogre::GL3PlusTextureGpuRenderTarget, Ogre::D3D11TextureGpuRenderTarget, Ogre::MetalTextureGpuRenderTarget, and Ogre::NULLTextureGpuRenderTarget.

◆ _setNextResidencyStatus()

void Ogre::GpuResource::_setNextResidencyStatus ( GpuResidency::GpuResidency nextResidency )

inherited

◆ _setSampleDescription()

void Ogre::TextureGpu::_setSampleDescription	(	SampleDescription	desc,
		SampleDescription	validatedSampleDesc
	)

inherited

For internal use.

◆ _setSourceType()

void Ogre::TextureGpu::_setSourceType ( uint8 type )

inherited

◆ _setToDisplayDummyTexture()

virtual void Ogre::MetalTextureGpu::_setToDisplayDummyTexture ( void )

virtual

Implements Ogre::TextureGpu.

Reimplemented in Ogre::MetalTextureGpuWindow.

◆ _syncGpuResidentToSystemRam()

void Ogre::TextureGpu::_syncGpuResidentToSystemRam ( void )

inherited

Forces downloading data from GPU to CPU, usually because the data on GPU changed and we're in strategy AlwaysKeepSystemRamCopy.

May stall.

◆ _transitionTo()

void Ogre::TextureGpu::_transitionTo	(	GpuResidency::GpuResidency	newResidency,
		uint8 *	sysRamCopy,
		bool	autoDeleteSysRamCopy = `true`
	)

inherited

This function may be called manually (if user is manually managing a texture) or automatically (e.g.

loading from file, or automatic batching is enabled) Once you call this function, you're no longer in OnStorage mode; and will transition to either OnSystemRam or Resident depending on whether auto batching is enabled.

Remarks: Do NOT call this function yourself if you've created this function with AutomaticBatching as Ogre will call this, from a worker thread!

Make sure you're done using mSysRamCopy before calling this function, as we may free that pointer (unless autoDeleteSysRamCopyOnResident = false).

If you're calling _transitionTo yourself (i.e. you're not using scheduleTransitionTo) then you'll need to call _setNextResidencyStatus too, so that both getResidencyStatus and getNextResidencyStatus agree.

Parameters

sysRamCopy System RAM copy that backs this GPU data. May be null. Must've been allocated with OGRE_MALLOC_SIMD( size, MEMCATEGORY_RESOURCE ); We will deallocate it. MUST respect _getSysRamCopyBytesPerRow & _getSysRamCopyBytesPerImage. If in doubt, use PixelFormatGpuUtils::getSizeBytes with rowAlignment = 4u;

This param must be nullptr or equal to get_getSysRamCopy when going from Resident to OnSystemRam and strategy is not AlwaysKeepSystemRamCopy; as we will async download the content from the GPU.

Parameters

autoDeleteSysRamCopy When true, we free mSysRamCopy as we should. When false, caller is responsible for deleting this pointer else it will leak!

◆ addListener()

void Ogre::TextureGpu::addListener ( TextureGpuListener * listener )

inherited

◆ allowsAutoMipmaps()

bool Ogre::TextureGpu::allowsAutoMipmaps ( void ) const

inherited

◆ copyContentsToMemory()

void Ogre::TextureGpu::copyContentsToMemory	(	TextureBox	src,
		TextureBox	dst,
		PixelFormatGpu	dstFormat,
		bool	automaticResolve = `true`
	)

inherited

Writes the current contents of the render target to the memory.

◆ copyParametersFrom()

void Ogre::TextureGpu::copyParametersFrom ( TextureGpu * src )

inherited

◆ copyTo()

virtual void Ogre::MetalTextureGpu::copyTo	(	TextureGpu *	dst,
		const TextureBox &	dstBox,
		uint8	dstMipLevel,
		const TextureBox &	srcBox,
		uint8	srcMipLevel,
		bool	keepResolvedTexSynced = `true`
	)

virtual

Parameters

dst
dstBox
dstMipLevel
srcBox
srcMipLevel
keepResolvedTexSynced	When true, if dst is an MSAA texture and is implicitly resolved (i.e. dst->hasMsaaExplicitResolves() == false); the resolved texture is also kept up to date.

Typically the reason to set this to false is if you plane on rendering more stuff to dst texture and then resolve.

Reimplemented from Ogre::TextureGpu.

◆ getCustomAttribute()

virtual void Ogre::TextureGpu::getCustomAttribute	(	IdString	name,
		void *	pData
	)

inlinevirtualinherited

Reimplemented in Ogre::GL3PlusTextureGpu, Ogre::D3D11TextureGpu, Ogre::MetalTextureGpuWindow, Ogre::D3D11TextureGpuWindow, and Ogre::GL3PlusTextureGpuWindow.

◆ getDepth()

uint32 Ogre::TextureGpu::getDepth ( void ) const

inherited

For TypeCube & TypeCubeArray, this value returns 1.

◆ getDepthBufferPoolId()

virtual uint16 Ogre::TextureGpu::getDepthBufferPoolId ( void ) const

virtualinherited

Reimplemented in Ogre::GL3PlusTextureGpuRenderTarget, Ogre::D3D11TextureGpuRenderTarget, Ogre::MetalTextureGpuRenderTarget, and Ogre::NULLTextureGpuRenderTarget.

◆ getDepthOrSlices()

uint32 Ogre::TextureGpu::getDepthOrSlices ( void ) const

inherited

◆ getDesiredDepthBufferFormat()

virtual PixelFormatGpu Ogre::TextureGpu::getDesiredDepthBufferFormat ( void ) const

virtualinherited

Reimplemented in Ogre::GL3PlusTextureGpuRenderTarget, Ogre::D3D11TextureGpuRenderTarget, Ogre::MetalTextureGpuRenderTarget, and Ogre::NULLTextureGpuRenderTarget.

◆ getDisplayTextureName()

id<MTLTexture> Ogre::MetalTextureGpu::getDisplayTextureName ( void ) const

inline

◆ getEmptyBox()

TextureBox Ogre::TextureGpu::getEmptyBox ( uint8 mipLevel )

inherited

◆ getFinalTextureName()

id<MTLTexture> Ogre::MetalTextureGpu::getFinalTextureName ( void ) const

inline

◆ getGpuPageOutStrategy()

GpuPageOutStrategy::GpuPageOutStrategy Ogre::GpuResource::getGpuPageOutStrategy ( void ) const

inherited

◆ getHeight()

uint32 Ogre::TextureGpu::getHeight ( void ) const

inherited

◆ getInternalSliceStart()

uint32 Ogre::TextureGpu::getInternalSliceStart ( void ) const

inherited

◆ getInternalTextureType()

TextureTypes::TextureTypes Ogre::TextureGpu::getInternalTextureType ( void ) const

inherited

◆ getListeners()

const vector<TextureGpuListener*>::type& Ogre::TextureGpu::getListeners ( void ) const

inherited

◆ getMsaaFramebufferName()

id<MTLTexture> Ogre::MetalTextureGpu::getMsaaFramebufferName ( void ) const

inline

◆ getName()

IdString Ogre::GpuResource::getName ( void ) const

inherited

◆ getNameStr()

virtual String Ogre::TextureGpu::getNameStr ( void ) const

virtualinherited

Note: This returns the alias name of the texture.

See TextureGpuManager::createOrRetrieveTexture

Reimplemented from Ogre::GpuResource.

◆ getNextResidencyStatus()

GpuResidency::GpuResidency Ogre::GpuResource::getNextResidencyStatus ( void ) const

inherited

When getResidencyStatus() != getNextResidencyStatus(), residency changes happen in the main thread, while some preparation may be happening in the background.

For example when a texture is not resident but getNextResidencyStatus says it will, a background thread is loading the texture file from disk, but the actual transition won't happen until the main thread changes it. You can call texture->waitForData() which will stall, as the main thread will be communicating back and forth with the background to see if it's ready; and when it is, the main thread will perform the transition inside waitForData

Likewise, if that texture is resident but will soon not be, it is still legal to access its contents as long as you access them from the main thread before that main thread changes the residency. This gives you a strong serialization guarantee, but be careful with async tickets such as AsyncTextureTickets:

If you call AsyncTextureTicket *asyncTicket = textureManager->createAsyncTextureTicket( ... ); assert( texture->getResidencyStatus() == GpuResidency::Resident ); ... do something else that calls Ogre functionality ... assert( texture->getResidencyStatus() == GpuResidency::Resident ); asyncTicket->download( texture, mip, true ); Then the second assert may trigger because that "do something else" ended up calling a function inside Ogre that finalized the transition. Once you've called download and the resource was still Resident, you are safe that your data integrity will be kept.

Remarks: Beware of the ABA problem. If the following transitions are scheduled: OnStorage -> Resident -> OnStorage Then both getResidencyStatus & getNextResidencyStatus will return OnStorage. Use GpuResource::getPendingResidencyChanges to fix the ABA problem.

◆ getNumMipmaps()

uint8 Ogre::TextureGpu::getNumMipmaps ( void ) const

inherited

◆ getNumSlices()

uint32 Ogre::TextureGpu::getNumSlices ( void ) const

inherited

For TypeCube this value returns 6.

For TypeCubeArray, value returns numSlices * 6u.

◆ getPendingResidencyChanges()

uint32 Ogre::GpuResource::getPendingResidencyChanges ( void ) const

inherited

Returns the number of pending residency changes.

Residency changes may not be immediate and thus be delayed (e.g. see TextureGpu::scheduleTransitionTo).

When this value is 0 it implies that mResidencyStatus == mNextResidencyStatus

◆ getPixelFormat()

PixelFormatGpu Ogre::TextureGpu::getPixelFormat ( void ) const

inherited

◆ getPreferDepthTexture()

virtual bool Ogre::TextureGpu::getPreferDepthTexture ( void ) const

virtualinherited

Reimplemented in Ogre::GL3PlusTextureGpuRenderTarget, Ogre::D3D11TextureGpuRenderTarget, Ogre::MetalTextureGpuRenderTarget, and Ogre::NULLTextureGpuRenderTarget.

◆ getRealResourceNameStr()

virtual String Ogre::TextureGpu::getRealResourceNameStr ( void ) const

virtualinherited

Returns the real name (e.g. disk in file) of the resource.

◆ getRequestedSampleDescription()

SampleDescription Ogre::TextureGpu::getRequestedSampleDescription ( void ) const

inherited

Returns original requested sample description, i.e. the raw input to setSampleDescription.

◆ getResidencyStatus()

GpuResidency::GpuResidency Ogre::GpuResource::getResidencyStatus ( void ) const

inherited

◆ getResourceGroupStr()

virtual String Ogre::TextureGpu::getResourceGroupStr ( void ) const

virtualinherited

◆ getSampleDescription()

SampleDescription Ogre::TextureGpu::getSampleDescription ( void ) const

inherited

Returns effective sample description supported by the API.

Note it's only useful after having transitioned to resident.

◆ getSettingsDesc()

String Ogre::TextureGpu::getSettingsDesc ( void ) const

inherited

◆ getSizeBytes()

size_t Ogre::TextureGpu::getSizeBytes ( void ) const

inherited

Returns total size in bytes used in GPU by this texture (not by its pool) including mipmaps.

◆ getSourceType()

uint8 Ogre::TextureGpu::getSourceType ( void ) const

inherited

◆ getSubsampleLocations()

virtual void Ogre::MetalTextureGpu::getSubsampleLocations ( vector< Vector2 >::type locations )

virtual

Get the MSAA subsample locations.

mSampleDescription.pattern must not be MsaaPatterns::Undefined.

Parameters

locations Outputs an array with the locations for each subsample. Values are in range [-1; 1]

Implements Ogre::TextureGpu.

◆ getTextureManager()

TextureGpuManager* Ogre::TextureGpu::getTextureManager ( void ) const

inherited

◆ getTexturePool()

const TexturePool* Ogre::TextureGpu::getTexturePool ( void ) const

inlineinherited

◆ getTexturePoolId()

uint32 Ogre::TextureGpu::getTexturePoolId ( void ) const

inlineinherited

◆ getTextureType()

TextureTypes::TextureTypes Ogre::TextureGpu::getTextureType ( void ) const

inherited

◆ getView() [1/3]

id<MTLTexture> Ogre::MetalTextureGpu::getView	(	PixelFormatGpu	pixelFormat,
		uint8	mipLevel,
		uint8	numMipmaps,
		uint16	arraySlice,
		bool	cubemapsAs2DArrays,
		bool	forUav
	)

◆ getView() [2/3]

id<MTLTexture> Ogre::MetalTextureGpu::getView ( DescriptorSetTexture2::TextureSlot texSlot )

◆ getView() [3/3]

id<MTLTexture> Ogre::MetalTextureGpu::getView ( DescriptorSetUav::TextureSlot uavSlot )

◆ getWidth()

uint32 Ogre::TextureGpu::getWidth ( void ) const

inherited

◆ hasAutomaticBatching()

bool Ogre::TextureGpu::hasAutomaticBatching ( void ) const

inherited

◆ hasAutoMipmapAuto()

bool Ogre::TextureGpu::hasAutoMipmapAuto ( void ) const

inherited

◆ hasEquivalentParameters()

bool Ogre::TextureGpu::hasEquivalentParameters ( TextureGpu * other ) const

inherited

◆ hasMsaaExplicitResolves()

bool Ogre::TextureGpu::hasMsaaExplicitResolves ( void ) const

inherited

◆ isDataReady()

bool Ogre::TextureGpu::isDataReady ( void )

inherited

True if this texture is fully ready to be used for displaying.

IMPORTANT: Always returns true if getResidencyStatus != GpuResidency::Resident and there are no pending residency transitions.

Returns false while there are pending residency status

If this is true, then isMetadataReady is also true. See isMetadataReady.

◆ isManualTexture()

bool Ogre::TextureGpu::isManualTexture ( void ) const

inherited

◆ isMetadataReady()

bool Ogre::TextureGpu::isMetadataReady ( void ) const

inherited

It is threadsafe to call this function from main thread.

If this returns false, then the following functions are not threadsafe: Setters must not be called, and getters may change from a worker thread: setResolution getWidth, getHeight, getDepth, getDepthOrSlices, getNumSlices set/getPixelFormat set/getNumMipmaps set/getTextureType getTexturePool Note that this function may return true but the worker thread may still be uploading to this texture. Use isDataReady to see if the worker thread is fully done with this texture.

Remarks: Function for querying/waiting for data and metadata to be ready are for blocking the main thread when a worker thread is loading the texture from file or a listener (i.e. isManualTexture returns false) otherwise you don't need to call these functions.

◆ isMsaaPatternSupported()

virtual bool Ogre::TextureGpu::isMsaaPatternSupported ( MsaaPatterns::MsaaPatterns pattern )

virtualinherited

Reimplemented in Ogre::D3D11TextureGpu.

◆ isMultisample()

bool Ogre::TextureGpu::isMultisample ( void ) const

inherited

◆ isOpenGLRenderWindow()

virtual bool Ogre::TextureGpu::isOpenGLRenderWindow ( void ) const

virtualinherited

OpenGL RenderWindows are a bit specific:

Their origins are upside down. Which means we need to flip Y.
They can access resolved contents of MSAA even if hasMsaaExplicitResolves = true

Reimplemented in Ogre::GL3PlusTextureGpuWindow.

◆ isPoolOwner()

bool Ogre::TextureGpu::isPoolOwner ( void ) const

inherited

◆ isReinterpretable()

bool Ogre::TextureGpu::isReinterpretable ( void ) const

inherited

◆ isRenderToTexture()

bool Ogre::TextureGpu::isRenderToTexture ( void ) const

inherited

◆ isRenderWindowSpecific()

bool Ogre::TextureGpu::isRenderWindowSpecific ( void ) const

inherited

◆ isTexture()

bool Ogre::TextureGpu::isTexture ( void ) const

inherited

◆ isUav()

bool Ogre::TextureGpu::isUav ( void ) const

inherited

◆ notifyAllListenersTextureChanged()

void Ogre::TextureGpu::notifyAllListenersTextureChanged	(	uint32	reason,
		void *	extraData = `0`
	)

inherited

◆ notifyDataIsReady()

virtual void Ogre::MetalTextureGpu::notifyDataIsReady ( void )

virtual

Notifies it is safe to use the real data. Everything has been uploaded.

Implements Ogre::TextureGpu.

Reimplemented in Ogre::MetalTextureGpuWindow.

◆ operator delete() [1/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void * ptr )

inlineinherited

◆ operator delete() [2/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		void *
	)

inlineinherited

◆ operator delete() [3/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)

inlineinherited

◆ operator delete[]() [1/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void * ptr )

inlineinherited

◆ operator delete[]() [2/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[]	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)

inlineinherited

◆ operator new() [1/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)

inlineinherited

operator new, with debug line info

◆ operator new() [2/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new ( size_t sz )

inlineinherited

◆ operator new() [3/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		void *	ptr
	)

inlineinherited

placement operator new

◆ operator new[]() [1/2]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[]	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)

inlineinherited

array operator new, with debug line info

◆ operator new[]() [2/2]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t sz )

inlineinherited

◆ prefersLoadingFromFileAsSRGB()

bool Ogre::TextureGpu::prefersLoadingFromFileAsSRGB ( void ) const

inherited

◆ removeListener()

void Ogre::TextureGpu::removeListener ( TextureGpuListener * listener )

inherited

◆ requiresTextureFlipping()

bool Ogre::TextureGpu::requiresTextureFlipping ( void ) const

inherited

◆ scheduleTransitionTo()

void Ogre::TextureGpu::scheduleTransitionTo	(	GpuResidency::GpuResidency	nextResidency,
		Image2 *	image = `0`,
		bool	autoDeleteImage = `true`
	)

inherited

Same as unsafeScheduleTransitionTo, but first checks if we're already in the residency state we want to go to, or if it has already been scheduled; thus it can be called multiple times.

◆ setNumMipmaps()

void Ogre::TextureGpu::setNumMipmaps ( uint8 numMipmaps )

inherited

◆ setPixelFormat()

void Ogre::TextureGpu::setPixelFormat ( PixelFormatGpu pixelFormat )

inherited

Sets the pixel format.

Remarks: If prefersLoadingFromFileAsSRGB() returns true, the format may not be fully honoured (as we'll use the equivalent _SRGB variation).

◆ setResolution()

void Ogre::TextureGpu::setResolution	(	uint32	width,
		uint32	height,
		uint32	depthOrSlices = `1u`
	)

inherited

◆ setSampleDescription()

void Ogre::TextureGpu::setSampleDescription ( SampleDescription desc )

inherited

◆ setTexturePoolId()

void Ogre::TextureGpu::setTexturePoolId ( uint32 poolId )

inherited

2D Texture with automatic batching will be merged with other textures into the same pool as one big 2D Array texture behind the scenes.

For two textures to be placed in the same pool (assuming it's not full) the following must match: Width, Height, PixelFormat, number of mipmaps, poolID

Pool ID is an arbitrary value with no actual meaning. This is ID allows you to prevent certain textures from being group together. For example, you may want all textures from Level 0 to be grouped together while Level 1 gets grouped together in a different pool

See also: TextureFlags::AutomaticBatching; TextureGpuManager::reservePoolId

Remarks: This value cannot be changed while the texture is resident (i.e. because it has already been assigned to a pool)

Parameters

poolId Arbitrary value. Default value is 0.

◆ setTextureType()

virtual void Ogre::MetalTextureGpu::setTextureType ( TextureTypes::TextureTypes textureType )

virtual

Reimplemented from Ogre::TextureGpu.

Reimplemented in Ogre::MetalTextureGpuWindow.

◆ supportsAsDepthBufferFor()

virtual bool Ogre::TextureGpu::supportsAsDepthBufferFor ( TextureGpu * colourTarget ) const

virtualinherited

◆ swapBuffers()

virtual void Ogre::TextureGpu::swapBuffers ( void )

inlinevirtualinherited

Only valid for TextureGpu classes.

TODO: This may be moved to a different class.

Reimplemented in Ogre::MetalTextureGpuWindow, Ogre::D3D11TextureGpuWindow, and Ogre::GL3PlusTextureGpuWindow.

◆ unsafeScheduleTransitionTo()

void Ogre::TextureGpu::unsafeScheduleTransitionTo	(	GpuResidency::GpuResidency	nextResidency,
		Image2 *	image = `0`,
		bool	autoDeleteImage = `true`
	)

inherited

Schedules an async transition in residency.

If transitioning from OnStorage to Resident, it will read from file (ResourceGroup was set in createTexture) If transitioning from OnSystemRam to Resident, it will read from the pointer it has. Multiple transitions can be stack together.

Remarks: If you're not loading from file (i.e. you're creating it programatically), call _transitionTo & _setNextResidencyStatus directly. Once you've called scheduleTransitionTo at least once, calling _transitionTo is very dangerous, as there are race conditions.

See also: TextureGpu::scheduleTransitionTo

Parameters

nextResidency	The residency to change to.
image	Pointer to image if you want to load the texture from memory instead of loading it from file or a listener. Pointer must be null if this is a manual texture. Pointer must NOT be a stack variable nor be deleted immediately. The actual loading is postponed until the request reaches the worker thread. That means the image pointer is safe to delete once you receive the TextureGpuListener::Reason::ReadyForRendering message.
autoDeleteImage	Whether we should call "delete image" once we're done using the image. Otherwise you must listen for TextureGpuListener::ReadyForRendering message to know when we're done using the image.

◆ waitForData()

void Ogre::TextureGpu::waitForData ( void )

inherited

Blocks main thread until data is ready.

Afterwards isDataReady should return true. If it doesn't, then there was a problem loading the texture. See isMetadataReady remarks.

◆ waitForMetadata()

void Ogre::TextureGpu::waitForMetadata ( void )

inherited

Blocks main thread until metadata is ready.

Afterwards isMetadataReady should return true. If it doesn't, then there was a problem loading the texture. See isMetadataReady remarks.

◆ writeContentsToFile()

void Ogre::TextureGpu::writeContentsToFile	(	const String &	filename,
		uint8	minMip,
		uint8	maxMip,
		bool	automaticResolve = `true`
	)

inherited

Writes the current contents of the render target to the named file.

Member Data Documentation

◆ msFinalTextureBuffer

const IdString Ogre::TextureGpu::msFinalTextureBuffer

staticinherited

◆ msMsaaTextureBuffer

const IdString Ogre::TextureGpu::msMsaaTextureBuffer

staticinherited

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

OgreMetalTextureGpu.h

Public Member Functions

Static Public Attributes

Constructor & Destructor Documentation

◆ MetalTextureGpu()

◆ ~MetalTextureGpu()

Member Function Documentation

◆ _addPendingResidencyChanges()

◆ _autogenerateMipmaps()

◆ _getSysRamCopy()

◆ _getSysRamCopyAsBox()

◆ _getSysRamCopyBytesPerImage()

◆ _getSysRamCopyBytesPerRow()

◆ _isDataReadyImpl()

◆ _isManualTextureFlagPresent()

◆ _notifySysRamDownloadIsReady()

◆ _notifyTextureSlotChanged()

◆ _resetTextureManager()

◆ _resolveTo()

◆ _setDepthBufferDefaults()

◆ _setNextResidencyStatus()

◆ _setSampleDescription()

◆ _setSourceType()

◆ _setToDisplayDummyTexture()

◆ _syncGpuResidentToSystemRam()

◆ _transitionTo()

◆ addListener()

◆ allowsAutoMipmaps()

◆ copyContentsToMemory()

◆ copyParametersFrom()

◆ copyTo()

◆ getCustomAttribute()

◆ getDepth()

◆ getDepthBufferPoolId()

◆ getDepthOrSlices()

◆ getDesiredDepthBufferFormat()

◆ getDisplayTextureName()

◆ getEmptyBox()

◆ getFinalTextureName()

◆ getGpuPageOutStrategy()

◆ getHeight()

◆ getInternalSliceStart()

◆ getInternalTextureType()

◆ getListeners()

◆ getMsaaFramebufferName()

◆ getName()

◆ getNameStr()

◆ getNextResidencyStatus()

◆ getNumMipmaps()

◆ getNumSlices()

◆ getPendingResidencyChanges()

◆ getPixelFormat()

◆ getPreferDepthTexture()

◆ getRealResourceNameStr()

◆ getRequestedSampleDescription()

◆ getResidencyStatus()

◆ getResourceGroupStr()

◆ getSampleDescription()

◆ getSettingsDesc()

◆ getSizeBytes()

◆ getSourceType()

◆ getSubsampleLocations()

◆ getTextureManager()

◆ getTexturePool()

◆ getTexturePoolId()

◆ getTextureType()

◆ getView() [1/3]

◆ getView() [2/3]

◆ getView() [3/3]

◆ getWidth()

◆ hasAutomaticBatching()

◆ hasAutoMipmapAuto()

◆ hasEquivalentParameters()

◆ hasMsaaExplicitResolves()

◆ isDataReady()

◆ isManualTexture()

◆ isMetadataReady()

◆ isMsaaPatternSupported()

◆ isMultisample()

◆ isOpenGLRenderWindow()

◆ isPoolOwner()