Click or drag to resize
Ab4d.SharpEngine logo

StandardMaterialBaseLoadDiffuseTexture(String, IBitmapIO, CommonSamplerTypes, Single, Boolean, Boolean, Boolean) Method

LoadDiffuseTexture lazily loads the specified textureFileName, creates a GpuImage object from the file and sets it to the DiffuseTexture property. The method also sets DiffuseTextureSamplerType and DiffuseTextureSampler properties. If this material was not yet initialized when this method is called (Scene property is not yet set), then the creation of the texture is postponed until the InitializeSceneResources method is called. To immediately create the texture, call this method and pass a VulkanDevice as the first parameter. When the created GpuImage is not cached by the Scene (useSceneCache is false by default) or GpuDevice (useGpuDeviceCache is true by default), then it is disposed when this Material is disposed.

Namespace: Ab4d.SharpEngine.Materials
Assembly: Ab4d.SharpEngine (in Ab4d.SharpEngine.dll) Version: 3.0.9208+3b2441d6a11f923f2600f40f4296bdc3d8b46035
Syntax
C#
Copy
public void LoadDiffuseTexture(
	string textureFileName,
	IBitmapIO? bitmapIO = null,
	CommonSamplerTypes samplerType = CommonSamplerTypes.Mirror,
	float alphaClipThreshold = 0f,
	bool useSceneCache = false,
	bool useGpuDeviceCache = true,
	bool loadInBackground = false
)

Parameters

textureFileName  String
texture file name
bitmapIO  IBitmapIO  (Optional)
Optional IBitmapIO that is used to load the texture. When null, then the DefaultBitmapIOis used
samplerType  CommonSamplerTypes  (Optional)
texture sampler type (Mirror by default)
alphaClipThreshold  Single  (Optional)
optional float that defines the AlphaClipThreshold (0 by default)
useSceneCache  Boolean  (Optional)
when true (false by default) than before loading the image the Scene's cache is checked if this file was already loaded. Also, the created GpuImage is cached by the Scene's cache.
useGpuDeviceCache  Boolean  (Optional)
when true (true by default) than before loading the image the GpuDevice's cache is checked if this file was already loaded. Also, the created GpuImage is cached by the GpuDevice's cache
loadInBackground  Boolean  (Optional)
when true (false by default) then the texture file is loaded in the background thread
See Also