aboutsummaryrefslogtreecommitdiff
path: root/APEX_1.4/shared/external/include/MaterialLibrary.h
diff options
context:
space:
mode:
authorgit perforce import user <a@b>2016-10-25 12:29:14 -0600
committerSheikh Dawood Abdul Ajees <Sheikh Dawood Abdul Ajees>2016-10-25 18:56:37 -0500
commit3dfe2108cfab31ba3ee5527e217d0d8e99a51162 (patch)
treefa6485c169e50d7415a651bf838f5bcd0fd3bfbd /APEX_1.4/shared/external/include/MaterialLibrary.h
downloadphysx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.tar.xz
physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.zip
Initial commit:
PhysX 3.4.0 Update @ 21294896 APEX 1.4.0 Update @ 21275617 [CL 21300167]
Diffstat (limited to 'APEX_1.4/shared/external/include/MaterialLibrary.h')
-rw-r--r--APEX_1.4/shared/external/include/MaterialLibrary.h131
1 files changed, 131 insertions, 0 deletions
diff --git a/APEX_1.4/shared/external/include/MaterialLibrary.h b/APEX_1.4/shared/external/include/MaterialLibrary.h
new file mode 100644
index 00000000..846057b5
--- /dev/null
+++ b/APEX_1.4/shared/external/include/MaterialLibrary.h
@@ -0,0 +1,131 @@
+/*
+ * Copyright (c) 2008-2015, NVIDIA CORPORATION. All rights reserved.
+ *
+ * NVIDIA CORPORATION and its licensors retain all intellectual property
+ * and proprietary rights in and to this software, related documentation
+ * and any modifications thereto. Any use, reproduction, disclosure or
+ * distribution of this software and related documentation without an express
+ * license agreement from NVIDIA CORPORATION is strictly prohibited.
+ */
+
+#ifndef MATERIAL_LIBRARY_H
+#define MATERIAL_LIBRARY_H
+
+#include "ApexUsingNamespace.h"
+#include "PxVec3.h"
+
+/**
+ Texture map types. Currently the MaterialLibrary interface only supports one map of each type.
+*/
+enum TextureMapType
+{
+ DIFFUSE_MAP = 0,
+ BUMP_MAP,
+ NORMAL_MAP,
+
+ TEXTURE_MAP_TYPE_COUNT
+};
+
+
+/**
+ Texture pixel format types, a supported by the Destruction tool's bmp, dds, and tga texture loaders.
+*/
+enum PixelFormat
+{
+ PIXEL_FORMAT_UNKNOWN,
+
+ PIXEL_FORMAT_RGB,
+ PIXEL_FORMAT_BGR_EXT,
+ PIXEL_FORMAT_BGRA_EXT,
+ PIXEL_FORMAT_COMPRESSED_RGBA_S3TC_DXT1_EXT,
+ PIXEL_FORMAT_COMPRESSED_RGBA_S3TC_DXT3_EXT,
+ PIXEL_FORMAT_COMPRESSED_RGBA_S3TC_DXT5_EXT,
+};
+
+
+/**
+ Basic interface to query generic texture map data.
+*/
+class TextureMap
+{
+public:
+
+ /** The texture pixel format, supported by the Destruction tool's texture loaders. */
+ virtual PixelFormat getPixelFormat() const = 0;
+
+ /** The horizontal texture map size, in pixels. */
+ virtual uint32_t getWidth() const = 0;
+
+ /** The vertical texture map size, in pixels. */
+ virtual uint32_t getHeight() const = 0;
+
+ /** The number of color/alpha/etc. channels. */
+ virtual uint32_t getComponentCount() const = 0;
+
+ /** The size, in bytes, of the pixel buffer. */
+ virtual uint32_t getPixelBufferSize() const = 0;
+
+ /** The beginning address of the pixel buffer. */
+ virtual uint8_t* getPixels() const = 0;
+};
+
+
+/**
+ Basic interface to query generic render material data.
+*/
+class Material
+{
+public:
+
+ /** The material's name, used by the named resource provider. */
+ virtual const char* getName() const = 0;
+
+ /** Access to the material's texture maps, indexed by TextureMapType. */
+ virtual TextureMap* getTextureMap(TextureMapType type) const = 0;
+
+ /** The ambient lighting color of the material. */
+ virtual const physx::PxVec3& getAmbient() const = 0;
+
+ /** The diffuse lighting color of the material. */
+ virtual const physx::PxVec3& getDiffuse() const = 0;
+
+ /** The specular lighting color of the material. */
+ virtual const physx::PxVec3& getSpecular() const = 0;
+
+ /** The opacity of the material. */
+ virtual float getAlpha() const = 0;
+
+ /** The shininess (specular power) of the material. */
+ virtual float getShininess() const = 0;
+};
+
+
+/**
+ Material library skeleton interface.
+*/
+class MaterialLibrary
+{
+public:
+
+ /** Saves the material to an physx::PxFileBuf. */
+ virtual void serialize(physx::PxFileBuf& stream) const = 0;
+
+ /** Loads material from an physx::PxFileBuf. */
+ virtual void deserialize(physx::PxFileBuf& stream) = 0;
+
+ /**
+ Query a material by name.
+ If the material already exists, it is returned and 'created' is set to false.
+ If the material did not exist before, it is created, returned, and 'created' is set to true.
+ */
+ virtual Material* getMaterial(const char* materialName, bool& created) = 0;
+
+ /**
+ Remove and delete named material.
+ Returns true if the material was found, false if it was not.
+ */
+ virtual bool deleteMaterial(const char* materialName) = 0;
+};
+
+
+#endif // #ifndef MATERIAL_LIBRARY_H