|
StandardMaterialBaseLoadDiffuseTexture(Scene, String, IBitmapIO, CommonSamplerTypes, Single, Boolean, Boolean) Method |
LoadDiffuseTexture immediately loads the specified textureFileName, creates a GpuImage object from the file and sets it to the
DiffuseTexture property.
The method also sets
DiffuseTexture,
DiffuseTextureSamplerType and
DiffuseTextureSampler properties.
Calling this method requires a valid Scene object that has initialized GpuDevice set.
When useGpuDeviceCache is true (by default), then before loading the image the Scene's cache is checked if this file was already loaded. Also, the create GpuImage is cached by the Scene's cache.
If you want to use GpuDevice case, use the method override that takes GpuDevice objects as parameter.
If you want to lazily create a diffuse texture before the device is known, call the method without the Scene 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.MaterialsAssembly: Ab4d.SharpEngine (in Ab4d.SharpEngine.dll) Version: 2.0.8956+4c7684e186ca1be74e7a284fbe739d9a1b843d3c
Syntax public GpuImage? LoadDiffuseTexture(
Scene scene,
string textureFileName,
IBitmapIO? bitmapIO = null,
CommonSamplerTypes samplerType = CommonSamplerTypes.Mirror,
float alphaClipThreshold = 0f,
bool useSceneCache = false,
bool useGpuDeviceCache = true
)
Parameters
- scene Scene
- Scene
- 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 create GpuImage is cached by the Scene's cache.
- useGpuDeviceCache Boolean (Optional)
- when true (by default) than before loading the image the GpuDevice's cache is checked if this file was already loaded. Also the create GpuImage is cached by the GpuDevice's cache
Return Value
GpuImagereturns created GpuImage
See Also