OGRE 2.1
Object-Oriented Graphics Rendering Engine
|
Contains information needed by PBS (Physically Based Shading) for OpenGL 3+ & D3D11+. More...
#include <OgreHlmsUnlitDatablock.h>
Static Public Member Functions | |
static const char * | getCmpString (CompareFunction compareFunction) |
Public Attributes | |
uint16 | mMacroblockHash [2] |
float | mShadowConstantBias |
uint32 | mTextureHash |
Matrix4 | mTextureMatrices [NUM_UNLIT_TEXTURE_TYPES] |
uint8 | mType |
Static Public Attributes | |
static const uint8 | A_MASK |
static const uint8 | B_MASK |
static const uint8 | G_MASK |
static const size_t | MaterialSizeInGpu |
static const size_t | MaterialSizeInGpuAligned |
static const uint8 | R_MASK |
Friends | |
class | HlmsUnlit |
Contains information needed by PBS (Physically Based Shading) for OpenGL 3+ & D3D11+.
Ogre::HlmsUnlitDatablock::HlmsUnlitDatablock | ( | IdString | name, |
HlmsUnlit * | creator, | ||
const HlmsMacroblock * | macroblock, | ||
const HlmsBlendblock * | blendblock, | ||
const HlmsParamVec & | params | ||
) |
Valid parameters in params:
params | diffuse [r g b [a]] If absent, the values of mR, mG, mB & mA will be ignored by the pixel shader. When present, the rgba values can be specified. Default: Absent Default (when present): diffuse 1 1 1 1 |
diffuse_map [texture name] [#uv] Name of the diffuse texture for the base image (optional, otherwise a dummy is set) The #uv parameter is optional, and specifies the texcoord set that will be used. Valid range is [0; 8) If the Renderable doesn't have enough UV texcoords, HLMS will throw an exception.
Note: The UV set is evaluated when creating the Renderable cache.
diffuse_map1 [texture name] [blendmode] [#uv] Name of the diffuse texture that will be layered on top of the base image. The #uv parameter is optional. Valid range is [0; 8) The blendmode parameter is optional. Valid values are: NormalNonPremul, NormalPremul, Add, Subtract, Multiply, Multiply2x, Screen, Overlay, Lighten, Darken, GrainExtract, GrainMerge, Difference which are very similar to Photoshop/GIMP's blend modes. See Samples/Media/Hlms/GuiMobile/GLSL/BlendModes_piece_ps.glsl for the exact math. Default blendmode: NormalPremul Default uv: 0 Example: diffuse_map1 myTexture.png Add 3
diffuse_map2 through diffuse_map16 Same as diffuse_map1 but for subsequent layers to be applied on top of the previous images. You can't leave gaps (i.e. specify diffuse_map0 & diffuse_map2 but not diffuse_map1). Note that not all mobile HW supports 16 textures at the same time, thus we will just cut/ignore the extra textures that won't fit (we log a warning though).
animate <#tex_unit> [<#tex_unit> <#tex_unit> ... <#tex_unit>] Enables texture animation through a 4x4 matrix for the specified textures. Default: All texture animation/manipulation disabled. Example: animate 0 1 2 3 4 14 15
alpha_test [compare_func] [threshold] When present, mAlphaTestThreshold is used. compare_func is optional. Valid values are: less, less_equal, equal, greater, greater_equal, not_equal Threshold is optional, and a value in the range (0; 1) Default: alpha_test less 0.5 Example: alpha_test equal 0.1
|
virtual |
Returns the internal index to the array in a texture array.
Note: If there is no texture assigned to the given texType, returned value is undefined
|
inherited |
|
inherited |
Calculates the hashes needed for sorting by the RenderQueue (i.e. mTextureHash)
Reimplemented from Ogre::HlmsDatablock.
|
inherited |
Creates a copy of this datablock with the same settings, but a different name.
name | Name of the cloned datablock. |
|
inherited |
|
inlineinherited |
Returns the index to mBakedTextures.
Returns NUM_PBSM_TEXTURE_TYPES if there is no texture assigned to texType
|
inlineinherited |
UnlitBlendModes Ogre::HlmsUnlitDatablock::getBlendMode | ( | uint8 | texType | ) | const |
|
staticinherited |
|
inline |
Gets the current colour. The returned value is meaningless if mHasColour is false.
|
inherited |
|
inlineinherited |
|
inlineinherited |
const HlmsSamplerblock * Ogre::HlmsUnlitDatablock::getSamplerblock | ( | uint8 | texType | ) | const |
TexturePtr Ogre::HlmsUnlitDatablock::getTexture | ( | uint8 | texType | ) | const |
If this returns false, the values of mR, mG, mB & mA will be ignored.
Reimplemented in Ogre::HlmsPbsDatablock.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
operator new, with debug line info
placement operator new
|
inlineinherited |
|
inlineinherited |
array operator new, with debug line info
|
virtualinherited |
folderPath | Folder where to dump the textures. |
savedTextures | [in/out] Set of texture names. Textures whose name is already in the set won't be saved again. Textures that were saved will be inserted into the set. |
saveOitd | When true, we will download the texture from GPU and save it in OITD format. OITD is faster to load as it's stored in Ogre's native format it understands, but it cannot be opened by traditional image editors; also OITD is not backwards compatible with older versions of Ogre. |
saveOriginal | When true, we will attempt to read the raw filestream of the original texture and save it (i.e. copy the original png/dds/etc file). |
Reimplemented in Ogre::HlmsPbsDatablock.
|
virtualinherited |
Sets the alpha test to the given compare function.
CMPF_ALWAYS_PASS means disabled.
compareFunction | Compare function to use. Default is CMPF_ALWAYS_PASS, which means disabled. Note: CMPF_ALWAYS_FAIL is not supported. Set a negative threshold to workaround this issue. |
Alpha test's threshold.
threshold | Value typically in the range [0; 1) |
Reimplemented in Ogre::HlmsPbsDatablock, and Ogre::HlmsPbsMobileDatablock.
|
inherited |
Sets a new blendblock that matches the same parameter as the input.
Decreases the reference count of the previous mBlendblock. Runs an O(N) search to get the right block. Calling this function triggers a HlmsDatablock::flushRenderables
blendblock | @See HlmsManager::getBlendblock |
casterBlock | True to directly set the blendblock to be used during the shadow mapping's caster pass. Note that when false, it will reset the caster block to the same as the regular one. |
|
inherited |
Sets the blendblock from the given pointer that was already retrieved from the HlmsManager.
Unlike the other overload, this operation is O(1). Calling this function triggers a HlmsDatablock::flushRenderables
blendblock | A valid block. The reference count is increased inside this function. |
casterBlock | True to directly set the blendblock to be used during the shadow mapping's caster pass. Note that when false, it will reset the caster block to the same as the regular one. |
void Ogre::HlmsUnlitDatablock::setBlendMode | ( | uint8 | texType, |
UnlitBlendModes | blendMode | ||
) |
Sets the blending mode (how the texture unit gets layered on top of the previous texture units).
Calling this function triggers a HlmsDatablock::flushRenderables.
texType | The texture unit. Must be in range [1; NUM_UNLIT_TEXTURE_TYPES) The value 0 is ignored. |
blendMode | The blending mode to use. |
void Ogre::HlmsUnlitDatablock::setColour | ( | const ColourValue & | diffuse | ) |
Sets a new colour value. Asserts if mHasColour is false.
Enables the animation of the given texture unit.
Calling this function triggers a HlmsDatablock::flushRenderables.
textureUnit | Texture unit. Must be in range [0; NUM_UNLIT_TEXTURE_TYPES) |
bEnable | Whether to enable or disable. Default is disabled. |
Set to true if the texture at the given texture unit is a planar reflection texture.
UVs will be ignored for that texture unit. Calling this function triggers a HlmsDatablock::flushRenderables.
textureUnit | Texture unit. Must be in range [0; NUM_UNLIT_TEXTURE_TYPES) |
bEnable | Whether to enable or disable. Default is disabled. |
|
inherited |
Sets a new macroblock that matches the same parameter as the input.
Decreases the reference count of the previously set one. Runs an O(N) search to get the right block. Calling this function triggers a HlmsDatablock::flushRenderables
macroblock | @See HlmsManager::getMacroblock |
casterBlock | True to directly set the macroblock to be used during the shadow mapping's caster pass. Note that when false, it will automatically reset the caster's block according to HlmsManager::setShadowMappingUseBackFaces setting. |
|
inherited |
Sets the macroblock from the given pointer that was already retrieved from the HlmsManager.
Unlike the other overload, this operation is O(1). Calling this function triggers a HlmsDatablock::flushRenderables
macroblock | A valid block. The reference count is increased inside this function. |
casterBlock | True to directly set the macroblock to be used during the shadow mapping's caster pass. Note that when false, it will automatically reset the caster's block according to HlmsManager::setShadowMappingUseBackFaces setting. |
void Ogre::HlmsUnlitDatablock::setSamplerblock | ( | uint8 | texType, |
const HlmsSamplerblock & | params | ||
) |
Sets a new sampler block to be associated with the texture (i.e.
filtering mode, addressing modes, etc). If the samplerblock changes, this function will always trigger a HlmsDatablock::flushRenderables
texType | Texture unit. Must be in range [0; NUM_UNLIT_TEXTURE_TYPES) |
params | The sampler block to use as reference. |
void Ogre::HlmsUnlitDatablock::setTexture | ( | uint8 | texType, |
uint16 | arrayIndex, | ||
const TexturePtr & | newTexture, | ||
const HlmsSamplerblock * | refParams = 0 |
||
) |
Sets a new texture for rendering.
Calling this function may trigger an HlmsDatablock::flushRenderables if the texture or the samplerblock changes. Won't be called if only the arrayIndex changes
texType | Texture unit. Must be in range [0; NUM_UNLIT_TEXTURE_TYPES) |
arrayIndex | The index in the array texture. |
newTexture | Texture to change to. If it is null and previously wasn't (or viceversa), will trigger HlmsDatablock::flushRenderables. |
params | Optional. We'll create (or retrieve an existing) samplerblock based on the input parameters. When null, we leave the previously set samplerblock (if a texture is being set, and if no samplerblock was set, we'll create a default one) |
void Ogre::HlmsUnlitDatablock::setTextureSwizzle | ( | uint8 | texType, |
uint8 | r, | ||
uint8 | g, | ||
uint8 | b, | ||
uint8 | a | ||
) |
Sets the final swizzle when sampling the given texture.
e.g. calling setTextureSwizzle( 0, R_MASK, G_MASK, R_MASK, G_MASK ); will generated the following pixel shader: vec4 texColour = texture( tex, uv ).xyxy;
Calling this function triggers a HlmsDatablock::flushRenderables.
texType | Texture unit. Must be in range [0; NUM_UNLIT_TEXTURE_TYPES) |
r | Where to source the red channel from. Must be R_MASK, G_MASK, B_MASK or A_MASK. Default: R_MASK |
g | Where to source the green channel from. Default: G_MASK |
b | Where to source the blue channel from. Default: B_MASK |
a | Where to source the alpha channel from. Default: A_MASK |
Sets which UV set to use for the given texture.
Calling this function triggers a HlmsDatablock::flushRenderables.
sourceType | Source texture to modify. Must be in range [0; NUM_UNLIT_TEXTURE_TYPES) |
uvSet | UV coordinate set. Value must be between in range [0; 8) |
Controls whether the value in.
|
inherited |
|
inherited |
|
inherited |
Matrix4 Ogre::HlmsUnlitDatablock::mTextureMatrices[NUM_UNLIT_TEXTURE_TYPES] |
|
inherited |