Start refactoring RS headerfiles for docs. (573fa620) · Commits · e / os / android_frameworks_base

libs/rs/scriptc/rs_allocation.rsh

0 → 100644

+144 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2011 The Android Open Source Project
		*
		* Licensed under the Apache License, Version 2.0 (the "License");
		* you may not use this file except in compliance with the License.
		* You may obtain a copy of the License at
		*
		* http://www.apache.org/licenses/LICENSE-2.0
		*
		* Unless required by applicable law or agreed to in writing, software
		* distributed under the License is distributed on an "AS IS" BASIS,
		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
		* See the License for the specific language governing permissions and
		* limitations under the License.
		*/

		/** @file rs_allocation.rsh
		* \brief Allocation routines
		*
		*
		*/

		#ifndef __RS_ALLOCATION_RSH__
		#define __RS_ALLOCATION_RSH__

		/**
		* Returns the Allocation for a given pointer. The pointer should point within
		* a valid allocation. The results are undefined if the pointer is not from a
		* valid allocation.
		*/
		extern rs_allocation __attribute__((overloadable))
		rsGetAllocation(const void *);

		/**
		* Query the dimension of an allocation.
		*
		* @return uint32_t The X dimension of the allocation.
		*/
		extern uint32_t __attribute__((overloadable))
		rsAllocationGetDimX(rs_allocation);

		/**
		* Query the dimension of an allocation.
		*
		* @return uint32_t The Y dimension of the allocation.
		*/
		extern uint32_t __attribute__((overloadable))
		rsAllocationGetDimY(rs_allocation);

		/**
		* Query the dimension of an allocation.
		*
		* @return uint32_t The Z dimension of the allocation.
		*/
		extern uint32_t __attribute__((overloadable))
		rsAllocationGetDimZ(rs_allocation);

		/**
		* Query an allocation for the presence of more than one LOD.
		*
		* @return uint32_t Returns 1 if more than one LOD is present, 0 otherwise.
		*/
		extern uint32_t __attribute__((overloadable))
		rsAllocationGetDimLOD(rs_allocation);

		/**
		* Query an allocation for the presence of more than one face.
		*
		* @return uint32_t Returns 1 if more than one face is present, 0 otherwise.
		*/
		extern uint32_t __attribute__((overloadable))
		rsAllocationGetDimFaces(rs_allocation);

		/**
		* Copy part of an allocation from another allocation.
		*
		* @param dstAlloc Allocation to copy data into.
		* @param dstOff The offset of the first element to be copied in
		* the destination allocation.
		* @param dstMip Mip level in the destination allocation.
		* @param count The number of elements to be copied.
		* @param srcAlloc The source data allocation.
		* @param srcOff The offset of the first element in data to be
		* copied in the source allocation.
		* @param srcMip Mip level in the source allocation.
		*/
		extern void __attribute__((overloadable))
		rsAllocationCopy1DRange(rs_allocation dstAlloc,
		uint32_t dstOff, uint32_t dstMip,
		uint32_t count,
		rs_allocation srcAlloc,
		uint32_t srcOff, uint32_t srcMip);

		/**
		* Copy a rectangular region into the allocation from another
		* allocation.
		*
		* @param dstAlloc allocation to copy data into.
		* @param dstXoff X offset of the region to update in the
		* destination allocation.
		* @param dstYoff Y offset of the region to update in the
		* destination allocation.
		* @param dstMip Mip level in the destination allocation.
		* @param dstFace Cubemap face of the destination allocation,
		* ignored for allocations that aren't cubemaps.
		* @param width Width of the incoming region to update.
		* @param height Height of the incoming region to update.
		* @param srcAlloc The source data allocation.
		* @param srcXoff X offset in data of the source allocation.
		* @param srcYoff Y offset in data of the source allocation.
		* @param srcMip Mip level in the source allocation.
		* @param srcFace Cubemap face of the source allocation,
		* ignored for allocations that aren't cubemaps.
		*/
		extern void __attribute__((overloadable))
		rsAllocationCopy2DRange(rs_allocation dstAlloc,
		uint32_t dstXoff, uint32_t dstYoff,
		uint32_t dstMip,
		rs_allocation_cubemap_face dstFace,
		uint32_t width, uint32_t height,
		rs_allocation srcAlloc,
		uint32_t srcXoff, uint32_t srcYoff,
		uint32_t srcMip,
		rs_allocation_cubemap_face srcFace);


		/**
		* Extract a single element from an allocation.
		*/
		extern const void * __attribute__((overloadable))
		rsGetElementAt(rs_allocation, uint32_t x);
		/**
		* \overload
		*/
		extern const void * __attribute__((overloadable))
		rsGetElementAt(rs_allocation, uint32_t x, uint32_t y);
		/**
		* \overload
		*/
		extern const void * __attribute__((overloadable))
		rsGetElementAt(rs_allocation, uint32_t x, uint32_t y, uint32_t z);

		#endif

libs/rs/scriptc/rs_atomic.rsh

0 → 100644

+248 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2011 The Android Open Source Project
		*
		* Licensed under the Apache License, Version 2.0 (the "License");
		* you may not use this file except in compliance with the License.
		* You may obtain a copy of the License at
		*
		* http://www.apache.org/licenses/LICENSE-2.0
		*
		* Unless required by applicable law or agreed to in writing, software
		* distributed under the License is distributed on an "AS IS" BASIS,
		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
		* See the License for the specific language governing permissions and
		* limitations under the License.
		*/

		/** @file rs_atomic.rsh
		* \brief Atomic routines
		*
		*
		*/

		#ifndef __RS_ATOMIC_RSH__
		#define __RS_ATOMIC_RSH__


		/**
		* Atomic add one to the value at addr.
		* Equal to rsAtomicAdd(addr, 1)
		*
		* @param addr Address of value to increment
		*
		* @return old value
		*/
		extern int32_t __attribute__((overloadable))
		rsAtomicInc(volatile int32_t* addr);
		/**
		* Atomic add one to the value at addr.
		* Equal to rsAtomicAdd(addr, 1)
		*
		* @param addr Address of value to increment
		*
		* @return old value
		*/
		extern uint32_t __attribute__((overloadable))
		rsAtomicInc(volatile uint32_t* addr);

		/**
		* Atomic subtract one from the value at addr. Equal to rsAtomicSub(addr, 1)
		*
		* @param addr Address of value to decrement
		*
		* @return old value
		*/
		extern int32_t __attribute__((overloadable))
		rsAtomicDec(volatile int32_t* addr);
		/**
		* Atomic subtract one from the value at addr. Equal to rsAtomicSub(addr, 1)
		*
		* @param addr Address of value to decrement
		*
		* @return old value
		*/
		extern uint32_t __attribute__((overloadable))
		rsAtomicDec(volatile uint32_t* addr);

		/**
		* Atomic add a value to the value at addr. addr[0] += value
		*
		* @param addr Address of value to modify
		* @param value Amount to add to the value at addr
		*
		* @return old value
		*/
		extern int32_t __attribute__((overloadable))
		rsAtomicAdd(volatile int32_t* addr, int32_t value);
		/**
		* Atomic add a value to the value at addr. addr[0] += value
		*
		* @param addr Address of value to modify
		* @param value Amount to add to the value at addr
		*
		* @return old value
		*/
		extern uint32_t __attribute__((overloadable))
		rsAtomicAdd(volatile uint32_t* addr, uint32_t value);

		/**
		* Atomic Subtract a value from the value at addr. addr[0] -= value
		*
		* @param addr Address of value to modify
		* @param value Amount to subtract from the value at addr
		*
		* @return old value
		*/
		extern int32_t __attribute__((overloadable))
		rsAtomicSub(volatile int32_t* addr, int32_t value);
		/**
		* Atomic Subtract a value from the value at addr. addr[0] -= value
		*
		* @param addr Address of value to modify
		* @param value Amount to subtract from the value at addr
		*
		* @return old value
		*/
		extern uint32_t __attribute__((overloadable))
		rsAtomicSub(volatile uint32_t* addr, uint32_t value);

		/**
		* Atomic Bitwise and a value from the value at addr. addr[0] &= value
		*
		* @param addr Address of value to modify
		* @param value Amount to and with the value at addr
		*
		* @return old value
		*/
		extern int32_t __attribute__((overloadable))
		rsAtomicAnd(volatile int32_t* addr, int32_t value);
		/**
		* Atomic Bitwise and a value from the value at addr. addr[0] &= value
		*
		* @param addr Address of value to modify
		* @param value Amount to and with the value at addr
		*
		* @return old value
		*/
		extern uint32_t __attribute__((overloadable))
		rsAtomicAnd(volatile uint32_t* addr, uint32_t value);

		/**
		* Atomic Bitwise or a value from the value at addr. addr[0] \|= value
		*
		* @param addr Address of value to modify
		* @param value Amount to or with the value at addr
		*
		* @return old value
		*/
		extern int32_t __attribute__((overloadable))
		rsAtomicOr(volatile int32_t* addr, int32_t value);
		/**
		* Atomic Bitwise or a value from the value at addr. addr[0] \|= value
		*
		* @param addr Address of value to modify
		* @param value Amount to or with the value at addr
		*
		* @return old value
		*/
		extern uint32_t __attribute__((overloadable))
		rsAtomicOr(volatile uint32_t* addr, uint32_t value);

		/**
		* Atomic Bitwise xor a value from the value at addr. addr[0] ^= value
		*
		* @param addr Address of value to modify
		* @param value Amount to xor with the value at addr
		*
		* @return old value
		*/
		extern uint32_t __attribute__((overloadable))
		rsAtomicXor(volatile uint32_t* addr, uint32_t value);
		/**
		* Atomic Bitwise xor a value from the value at addr. addr[0] ^= value
		*
		* @param addr Address of value to modify
		* @param value Amount to xor with the value at addr
		*
		* @return old value
		*/
		extern int32_t __attribute__((overloadable))
		rsAtomicXor(volatile int32_t* addr, int32_t value);

		/**
		* Atomic Set the value at addr to the min of addr and value
		* addr[0] = rsMin(addr[0], value)
		*
		* @param addr Address of value to modify
		* @param value comparison value
		*
		* @return old value
		*/
		extern uint32_t __attribute__((overloadable))
		rsAtomicMin(volatile uint32_t* addr, uint32_t value);
		/**
		* Atomic Set the value at addr to the min of addr and value
		* addr[0] = rsMin(addr[0], value)
		*
		* @param addr Address of value to modify
		* @param value comparison value
		*
		* @return old value
		*/
		extern int32_t __attribute__((overloadable))
		rsAtomicMin(volatile int32_t* addr, int32_t value);

		/**
		* Atomic Set the value at addr to the max of addr and value
		* addr[0] = rsMax(addr[0], value)
		*
		* @param addr Address of value to modify
		* @param value comparison value
		*
		* @return old value
		*/
		extern uint32_t __attribute__((overloadable))
		rsAtomicMax(volatile uint32_t* addr, uint32_t value);
		/**
		* Atomic Set the value at addr to the max of addr and value
		* addr[0] = rsMin(addr[0], value)
		*
		* @param addr Address of value to modify
		* @param value comparison value
		*
		* @return old value
		*/
		extern int32_t __attribute__((overloadable))
		rsAtomicMax(volatile int32_t* addr, int32_t value);

		/**
		* Compare-and-set operation with a full memory barrier.
		*
		* If the value at addr matches compareValue then newValue is written.
		*
		* @param addr The address to compare and replace if the compare passes.
		* @param compareValue The value to test addr[0] against.
		* @param newValue The value to write if the test passes.
		*
		* @return old value
		*/
		extern int32_t __attribute__((overloadable))
		rsAtomicCas(volatile int32_t* addr, int32_t compareValue, int32_t newValue);

		/**
		* Compare-and-set operation with a full memory barrier.
		*
		* If the value at addr matches compareValue then newValue is written.
		*
		* @param addr The address to compare and replace if the compare passes.
		* @param compareValue The value to test addr[0] against.
		* @param newValue The value to write if the test passes.
		*
		* @return old value
		*/
		extern uint32_t __attribute__((overloadable))
		rsAtomicCas(volatile uint32_t* addr, int32_t compareValue, int32_t newValue);


		#endif

libs/rs/scriptc/rs_cl.rsh

+22 −3

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2011 The Android Open Source Project
		*
		* Licensed under the Apache License, Version 2.0 (the "License");
		* you may not use this file except in compliance with the License.
		* You may obtain a copy of the License at
		*
		* http://www.apache.org/licenses/LICENSE-2.0
		*
		* Unless required by applicable law or agreed to in writing, software
		* distributed under the License is distributed on an "AS IS" BASIS,
		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
		* See the License for the specific language governing permissions and
		* limitations under the License.
		*/

		/** @file rs_cl.rsh
		* \brief Additional compute routines
		*
		*
		*/

		#ifndef __RS_CL_RSH__
		#define __RS_CL_RSH__

		#define _RS_RUNTIME extern

		// Conversions
		#define CVT_FUNC_2(typeout, typein) \
		_RS_RUNTIME typeout##2 __attribute__((overloadable)) \
		@@ -444,6 +464,5 @@ _RS_RUNTIME float4 __attribute__((overloadable)) normalize(float4 v);
		#undef IN_FUNC_IN
		#undef XN_FUNC_XN_XN_BODY
		#undef IN_FUNC_IN_IN_BODY
		#undef _RS_RUNTIME

		#endif

libs/rs/scriptc/rs_core.rsh

+105 −828

File changed.

Preview size limit exceeded, changes collapsed.

libs/rs/scriptc/rs_debug.rsh

0 → 100644

+123 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2011 The Android Open Source Project
		*
		* Licensed under the Apache License, Version 2.0 (the "License");
		* you may not use this file except in compliance with the License.
		* You may obtain a copy of the License at
		*
		* http://www.apache.org/licenses/LICENSE-2.0
		*
		* Unless required by applicable law or agreed to in writing, software
		* distributed under the License is distributed on an "AS IS" BASIS,
		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
		* See the License for the specific language governing permissions and
		* limitations under the License.
		*/

		/** @file rs_debug.rsh
		* \brief Utility debugging routines
		*
		* Routines intended to be used during application developement. These should
		* not be used in shipping applications. All print a string and value pair to
		* the standard log.
		*
		*/

		#ifndef __RS_DEBUG_RSH__
		#define __RS_DEBUG_RSH__



		/**
		* Debug function. Prints a string and value to the log.
		*/
		extern void __attribute__((overloadable))
		rsDebug(const char *, float);
		/**
		* Debug function. Prints a string and value to the log.
		*/
		extern void __attribute__((overloadable))
		rsDebug(const char *, float, float);
		/**
		* Debug function. Prints a string and value to the log.
		*/
		extern void __attribute__((overloadable))
		rsDebug(const char *, float, float, float);
		/**
		* Debug function. Prints a string and value to the log.
		*/
		extern void __attribute__((overloadable))
		rsDebug(const char *, float, float, float, float);
		/**
		* Debug function. Prints a string and value to the log.
		*/
		extern void __attribute__((overloadable))
		rsDebug(const char *, double);
		/**
		* Debug function. Prints a string and value to the log.
		*/
		extern void __attribute__((overloadable))
		rsDebug(const char , const rs_matrix4x4 );
		/**
		* Debug function. Prints a string and value to the log.
		*/
		extern void __attribute__((overloadable))
		rsDebug(const char , const rs_matrix3x3 );
		/**
		* Debug function. Prints a string and value to the log.
		*/
		extern void __attribute__((overloadable))
		rsDebug(const char , const rs_matrix2x2 );
		/**
		* Debug function. Prints a string and value to the log.
		*/
		extern void __attribute__((overloadable))
		rsDebug(const char *, int);
		/**
		* Debug function. Prints a string and value to the log.
		*/
		extern void __attribute__((overloadable))
		rsDebug(const char *, uint);
		/**
		* Debug function. Prints a string and value to the log.
		*/
		extern void __attribute__((overloadable))
		rsDebug(const char *, long);
		/**
		* Debug function. Prints a string and value to the log.
		*/
		extern void __attribute__((overloadable))
		rsDebug(const char *, unsigned long);
		/**
		* Debug function. Prints a string and value to the log.
		*/
		extern void __attribute__((overloadable))
		rsDebug(const char *, long long);
		/**
		* Debug function. Prints a string and value to the log.
		*/
		extern void __attribute__((overloadable))
		rsDebug(const char *, unsigned long long);
		/**
		* Debug function. Prints a string and value to the log.
		*/
		extern void __attribute__((overloadable))
		rsDebug(const char , const void );
		#define RS_DEBUG(a) rsDebug(#a, a)
		#define RS_DEBUG_MARKER rsDebug(__FILE__, __LINE__)


		/**
		* Debug function. Prints a string and value to the log.
		*/
		_RS_RUNTIME void __attribute__((overloadable)) rsDebug(const char *s, float2 v);
		/**
		* Debug function. Prints a string and value to the log.
		*/
		_RS_RUNTIME void __attribute__((overloadable)) rsDebug(const char *s, float3 v);
		/**
		* Debug function. Prints a string and value to the log.
		*/
		_RS_RUNTIME void __attribute__((overloadable)) rsDebug(const char *s, float4 v);

		#endif